Represents the company's organizational model and it is provided by the Workflow API.
Property |
Type |
Access |
Description |
Error |
WorkflowError |
Read |
Error code |
List Users
This method returns a collection with all the organization's users matching the specified filter.
ListUsers (filter): Collection (WorkflowUser)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters : Role, Name, ProcessInstance |
Input |
Filter |
ListUsersOrderBy
This method returns a collection with all the organization's users matching the specified filter in the specified order.
ListUsersOrderBy (filter, order): Collection (WorkflowUser)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: Role, Name, ProcessInstance |
Input |
Filter |
2 |
order |
WorkflowOrder (WorkflowOrder.ID_ASC, WorkflowOrder.ID_DESC, WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) |
Input |
Order |
ListRoles
This method returns a collection with the organization functional roles matching the specified filter.
ListRoles (filter): Collection (WorkflowRole)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: User, Activity, Process Definition, Name |
Input |
Filter |
This method returns a collection with the organization's functional roles matching the specified filter in the specified order.
ListRolesOrderBy (filter, order): Collection (WorkflowRole)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: User, Activity, Process Definition, Name |
Input |
Filter |
2 |
order |
WorkflowOrder (WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) |
Input |
Order |
This method returns a collection with the restriction definitions matching the specified filter.
ListRestrictionDefinitions (filter): Collection (WorkflowRestrictionDefinition)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: None |
Input |
Filter |
This method returns a collection with the restriction definitions matching the specified filter in the specified order.
ListRestrictionDefinitionsOrderBy (filter, order): Collection (WorkflowRestrictionDefinition)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters : None |
Input |
Filter |
2 |
order |
WorkflowOrder (WorkflowOrder.ID_ASC, WorkflowOrder.ID_DESC, WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) |
Input |
Order |
This method returns a collection with the restrictions matching the specified filter.
ListRestrictions (filter): Collection (WorkflowRestriction)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters : Restriction |
Input |
Filter |
This method returns a collection with the restrictions matching the specified filter in the specified order.
ListRestrictionsOrderBy (filter, order): Collection (WorkflowRestriction)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: Restriction |
Input |
Filter |
2 |
order |
WorkflowOrder (WorkflowOrder.ID_ASC, WorkflowOrder.ID_DESC, WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) |
Input |
Order |
This method returns a User type object whose identifier coincides with the specified one.
GetUserById (id): WorkflowUser
|
Name |
Type |
Movement |
Description |
1 |
id |
WorkflowUserId |
Input |
User Identifier |
This method returns the first User type object whose name coincides with the specified one.
GetUserByName (name): WorkflowUser
|
Name |
Type |
Movement |
Description |
1 |
name |
WorkflowName |
Input |
User name |
This method returns a Role type object whose identifier coincides with the specified one.
GetRoleById (id): WorkflowRole
|
Name |
Type |
Movement |
Description |
1 |
Id |
WorkflowRoleId |
Input |
Role Identifier |
This method returns the first Role type object whose name coincides with the specified one.
GetRoleByName (name): WorkflowRole
|
Name |
Type |
Movement |
Description |
1 |
name |
WorkflowName |
Input |
Role name |
This method returns a Role type object whose GUID coincides with the specified one.
GetRoleWithGUID (GUID): WorkflowRole
|
Name |
Type |
Movement |
Description |
1 |
GUID |
Character |
Input |
RoleGUID |
This method returns the first Restriction Definition type object whose name coincides with the specified one.
GetRestrictionDefinitionByName (name): WorkflowRestrictionDefinition
|
Name |
Type |
Movement |
Description |
1 |
Name |
WorkflowName |
Input |
Name of restriction definition |
This method adds a new user to the organization.
AddUser (id, name, email, accessLevel, password): WorkflowUser
This method adds a new role to the organization.
AddRole (name): WorkflowRole
|
Name |
Type |
Movement |
Description |
1 |
name |
WorkflowName |
Input |
Rol Name |
This method adds a new restriction definition.
AddRestrictionDefinition (name, description, type): WorkflowRestrictionDefinition
This method returns an organizational unit definition by name.
GetOrganizationalUnitDefinitionByName(name): WorkflowOrganizationalUnitDefinition
This method returns an organizational unit by name.
GetOrganizationalUnitByName(name): WorkflowOrganizationalUnit
|
Name |
Type |
Movement |
Description |
1 |
name |
WorkflowName |
Input |
Name |
This method lists the organizational units definitions.
ListOrganizationalUnitDefinitions (filter): Collection (WorkflowOrganizationalUnitDefinition)
This method lists the organizational units definitions. It is possible to sort the result.
ListOrganizationalUnitDefinitions (filter, order): Collection (WorkflowOrganizationalUnitDefinition)
This method lists the organizational units.
ListOrganizationalUnits (filter): Collection (WorkflowOrganizationalUnit)
|
Name |
Type |
Movement |
Description |
1 |
Filter |
WorkflowFilter Valid Filters: Start, Limit |
Input |
Filter |
This method returns the organizational units list. It is possible to sort the result.
ListOrganizationalUnitsOrderBy (filter, order): Collection (WorkflowOrganizationalUnit)
This method adds an organizational unit definition.
AddOrganizationalUnitDefinition(name,description, propagable): WorkflowOrganizationalUnitDefinition
|
Name |
Type |
Movement |
Description |
1 |
name |
WorkflowName |
Input |
Name |
2 |
description |
WorkflowDescription |
Input |
Description |
3 |
propagable |
Boolean |
Input |
Indicates that the user's organizational unit will be inherited by the process |
This method adds an organizational unit.
AddOrganizationalUnit(definition name, name,description): WorkflowOrganizationalUnit
This method allows to remove a user.
RemoveUser(user)
|
Name |
Type |
Movement |
Description |
1 |
user |
WorkflowUser |
Input |
User to be removed |
This method allows to remove a role.
RemoveRole(role)
This method returns a collection with the user roles matching the specified filter. It does not include the roles created from the GeneXus IDE.
ListApplicationRoles (filter): Collection (WorkflowRole)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: User, Activity, Process Definition, Name |
Input |
Filter |
This method returns a collection with the user roles matching the specified filter in the specified order. It does not include the roles created from the GeneXus IDE.
ListApplicationRolesOrderBy (filter, order): Collection (WorkflowRole)
|
Name |
Type |
Movement |
Description |
1 |
filter |
WorkflowFilter Valid Filters: User, Activity, Process Definition, Name |
Input |
Filter |
2 |
order |
WorkflowOrder (WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) |
Input |
Order |
Workflow Error Codes