WorkflowOrganizationalModel Data Type

Official Content
This documentation is valid for:

This object represents the company organizational model.

Properties

 

Property Type Access Description
Error WorkflowError Read Error code

 

Methods

  • List Users


This method returns a collection with all the organization 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 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
  • ListRolesOrderBy

This method returns a collection with the organization 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
  • ListRestrictionDefinitions (Deprecated)


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
  • ListRestrictionDefinitionsOrderBy (Deprecated)

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

 

  • ListRestrictions (Deprecated)


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

 

  • ListRestrictionsOrderBy (Deprecated)

 

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

 

  • GetUserById


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

 

  • GetUserByName

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

 

  • GetRoleById

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 Rol Identifier

 

  • GetRoleByName

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 Rol name

 

  • GetRestrictionDefinitionByName (Deprecated)

 

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

 

  • AddUser

This method adds a new user to the organization.

AddUser (id, name, email, accessLevel, password): WorkflowUser

  Name Type Movement Description
1 id WorkflowUserId Input User Identifier (login)
2 name WorkflowName Input User Name
3 email WorkflowEmail Input E-mail address
4 password WorkflowPassword Input User Password

 

  • AddRole

This method adds a new role to the organization.

AddRole (name): WorkflowRole

  Name Type Movement Description
1 name WorkflowName Input Rol Name

 

  • AddRestrictionDefinition (Deprecated)

 

This method adds a new restriction definition.

AddRestrictionDefinition (name, description, type): WorkflowRestrictionDefinition

  Name Type Movement Description
1 name WorkflowName Input Restriction Name
2 description WorkflowDescription Input Restriction Description
3 type WorkflowRestrictionDefinitionType Input Restriction Type

 

  • GetOrganizationalUnitDefinitionByName

 

This method returns an organizational unit definition by name.

GetOrganizationalUnitDefinitionByName(name): WorkflowOrganizationalUnitDefinition

  Name Type Pasaje Description
1 name WorkflowName Input Name

 

  • GetOrganizationalUnitByName

This method returns an organizational unit by name.

GetOrganizationalUnitByName(name): WorkflowOrganizationalUnit

  Name Type Movement Description
1 name WorkflowName Input Name

 

  • ListOrganizationalUnitDefinitions

This method lists the organizational units definitions.

ListOrganizationalUnitDefinitions (filter): Collection (WorkflowOrganizationalUnitDefinition)

  Name Type Movement Description
1 filter WorkflowFilter Input Filter

 

  • ListOrganizationalUnitDefinitionsOrderBy

 
This method lists the organizational units definitions. It is possible to sort the result.

ListOrganizationalUnitDefinitions (filter, order): Collection (WorkflowOrganizationalUnitDefinition)

  Name Type Movement Description
1 filter WorkflowFilter Input Filter
2 Order WorkflowOrder Input Order
  • ListOrganizationalUnits

This method lists the organizational units.

ListOrganizationalUnits (filter): Collection (WorkflowOrganizationalUnit)

  Name Type Movement Description
1 Filter WorkflowFilter Valid Filters: Start, Limit Input Filter

 

  • ListOrganizationalUnitsOrderBy

 This method returns the organizational units list. It is possible to sort the result.

ListOrganizationalUnitsOrderBy (filter, order): Collection (WorkflowOrganizationalUnit)

  Name Type Movement Description
1 filter WorkflowFilter Valid Filters: Start, Limit Input Filter
2 Order WorkflowOrder Input Order
  • AddOrganizationalUnitDefinition

 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
  • AddOrganizationalUnit

 This method adds an organizational unit.


AddOrganizationalUnit(definition name, name,description): WorkflowOrganizationalUnit

  Name Type Movement Description
1 definition name WorkflowName Input Definition Name
2 name WorkflowName Input Name
3 description WorkflowDescription Input Description
  • RemoveUser

 This method allows to remove a user.


RemoveUser(user)

  Name Type Movement Description
1 user WorkflowUser Input User to be removed
  • ListApplicationRoles


This method returns a collection with the user roles matching the specified filter. It does not include the roles created from the GX IDE.

ListApplicationRoles (filter): Collection (WorkflowRole)

  Name Type Movement Description
1 filter WorkflowFilter Valid Filters: User, Activity, Process Definition, Name Input Filter
  • ListApplicationRolesOrderBy

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 GX 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

See Also



Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.