...
- Accepts one group to save
- Documentation: SOAP (click on groupSaveLite), REST (click on groupSaveLite)
- For REST, the request can put data in query string (in URL or request body)
- REST request (colon is escaped to %3A): PUT /grouper-ws/servicesRest/v1_3_000/groups/aStem%3AaGroup
- (see documentation above for details): Request object, response object
- Response codes
- Samples (all files with "Lite" in them, click on "download" to see file)
...
- Accepts multiple groups to save
- This will persist (insert/update/delete) types, attributes, composites from detail
- Documentation: SOAP (click on groupSave), REST (click on groupSave)
- REST request (colon is escaped to %3A): PUT /grouper-ws/servicesRest/v1_3_000/groups
- (see documentation above for details): Request object, response object
- Response codes overall, response codes for each assignment
- Returns an overall status, and a status for each assignment
- Samples (all files without "Lite" in them, click on "download" to see files)
...
This will return the destination stem with the extension of the Group (which may or may not be the group that was copied)
| Param | Value | Notes |
|---|---|---|
| [--paramName0=moveOrCopy] [--paramValue0=copy] | move|copy | |
| [--paramName1=moveOrCopyToStemUuid] [--paramValue1=abc123] | uuid of a stem to move or copy to | mutually exclusive with moveOrCopyStemName and moveOrCopyToStemIdIndex |
| [--paramName2=moveOrCopyToStemName] [--paramValue2=a:b:c] | name of stem to move or copy to | mutually exclusive with moveOrCopyStemUuid and moveOrCopyToStemIdIndex |
| [--paramName3=moveOrCopyToStemIdIndex] [--paramValue3=19] | id index of stem to move or copy to | mutually exclusive with moveOrCopyStemUuid and moveOrCopyStemName |
| [--paramName4=copyPrivilegesOfGroup] [--paramValue4=true] | true|false | Whether to copy the access privileges of the group. If this option is selected, you must have READ access to all privileges. |
| [--paramName5=copyGroupAsPrivilege] [--paramValue5=true] | true|false | Whether to copy access and naming privileges where the group is a member. For instance, if you are copying Group X and Group X has admin privileges to Group Y, then if this option is enabled, after Group X is copied, the new group will also have admin privileges to Group Y. If this option is selected, you must have access to add privileges to the other groups and folders. |
| [--paramName6=copyListMembersOfGroup ] [--paramValue6=true] | true|false | Whether to copy list memberships of the group. If this option is selected and this group has custom lists, you must have read access to them. |
| [--paramName7=copyListGroupAsMember ] [--paramValue7=true] | true|false | Whether to copy list memberships where the group is a member. For instance, if you are copying Group X and Group X is a member of Group Y, then if this option is enabled, after Group X is copied, the new group will also be a member of Group Y. If this option is selected, you must have access to add memberships to the other groups. |
| [--paramName8=copyAttributes ] [--paramValue8=true] | true|false | Whether to copy attributes. If this option is selected, you must have READ access to all attributes. These are attributes that are added to GroupTypes. This does not include attributes in the new attribute framework in v1.5.0. |
| [--paramName9=moveAssignAlternateName ] [--paramValue9=true] | true|false | Whether to assign the old name of the group as an alternate name of the group after the move. This allows API methods like GroupFinder.findByName() to find the group using the old and new names and can make it easier to transition from the old name to the new name. |
Example
| Code Block |
|---|
<WsRestGroupSaveRequest>
<wsGroupToSaves>
<WsGroupToSave>
<wsGroupLookup>
<groupName>test:testGroupToCopy</groupName>
</wsGroupLookup>
<wsGroup>
<displayExtension>testGroupToCopy</displayExtension>
<name>test:testGroupToCopy</name>
</wsGroup>
</WsGroupToSave>
</wsGroupToSaves>
<params>
<WsParam>
<paramName>moveOrCopy</paramName>
<paramValue>copy</paramValue>
</WsParam>
<WsParam>
<paramName>moveOrCopyToStemName</paramName>
<paramValue>test:stemDestination</paramValue>
</WsParam>
<WsParam>
<paramName>copyPrivilegesOfGroup</paramName>
<paramValue>true</paramValue>
</WsParam>
<WsParam>
<paramName>copyGroupAsPrivilege</paramName>
<paramValue>true</paramValue>
</WsParam>
<WsParam>
<paramName>copyListMembersOfGroup</paramName>
<paramValue>true</paramValue>
</WsParam>
<WsParam>
<paramName>copyListGroupAsMember</paramName>
<paramValue>true</paramValue>
</WsParam>
<WsParam>
<paramName>copyAttributes</paramName>
<paramValue>true</paramValue>
</WsParam>
</params>
</WsRestGroupSaveRequest> |
...