Wednesday, April 16, 2014

Autodesk Vault Programmer's Cookbook. 3. Groups



Navigation:

|
|

Vault API provides a number of methods for working with groups. They're located in AdminService service. With next pivot table you can get an overview of this methods.
Operation
Object
Option
Name
Add
Group

AddGroup
ToGroup
AddGroupToGroup
ToVault
AddGroupToVault
Groups
ToGroup
AddGroupsToGroup
GroupRole

AddGroupRole
Delete
Group
FromGroup
DeleteGroup FromGroup
FromVault
DeleteGroup FromVault
Groups
FromGroup
DeleteGroups FromGroup
GroupRole

DeleteGroupRole
Get
Group
ById
GetGroupById
ByName
GetGroupByName
Groups
ByIds
GetGroupsByIds
ByNames
GetGroupsByNames
AllGroups

GetAllGroups
Child GroupIds
ByGroupId
GetChildGroupIds ByGroupId
GroupInfo
ByGroupId
GetGroupInfo ByGroupId
GroupInfos
ByGroupIds
GetGroupInfos ByGroupIds
Member Groups
ByGroupId
GetMember GroupsByGroupId
Parent GroupIds
ByGroupId
GetParentGroup IdsByGroupId
Update
GroupInfo

UpdateGroupInfo
To call method
To call the method in relation to a particular group - or groups - enough to know their names or IDs. This information is stored in the class Group. It has next fields:
Name
Description
Auth
The authentication type.
CreateDate
The date the Group was created.
CreateUserId
The Id of the User that created the Group.
EmailDL
The email address (distribution list) for the Group.
Id
The identifier for the object.
IsActive
If true, the Group is active. If false, the Group is inactive.
IsSys
If true, the Group is a system group. If false, the Group is user-defined.
Name
The unique name of the Group.
Group class is inbound for GropInfo class, which has the following fields:
Name
Description
Group
A Group.
Groups
The immediate Groups in the Group.
Roles
The Roles associated with the Group.
Users
The immediate Users in the Group.
Vaults
The Vaults associated with the Group.
Remember this distribution when you're working with groups. It should also be noted that the GroupInfo fields does not return ID objects and references to the objects themselves.