Update the specified hierarchical members.
patch
/social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Request
Supported Media Types
- application/json
Path Parameters
-
hierarchicalMemberID: integer(int64)
The hierarchical member ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1HierarchicalMembersUpdateInfo
Type:
object
V1 Collaboration API Hierarchical Members update DTO.
Show Source
-
addedMemberGroups(optional):
array addedMemberGroups
List of added groups. Can be empty. This can specify the group externalID, name or objectID.
-
addedMemberUserNames(optional):
array addedMemberUserNames
List of added users. Can be empty.
-
childFolderIDs(optional):
array childFolderIDs
List of child folder IDs. Can be empty. Use this to build up parent-child relationships within the member hierarchy.
-
childUpdateInfos(optional):
array childUpdateInfos
List of child XV1HierarchicalMembersUpdateInfos.
-
conversationID(optional):
integer(int64)
The conversation ID for a file. To be used with the MOVE_FILE operation.
-
EVERYONE_GROUP(optional):
string
Canonical everyone group name.
-
fileID(optional):
string
The file ID. To be used with the MOVE_FILE operation.
-
findOrCreateConversation(optional):
boolean
If set true will find an existing conversation for the CREATE_CONVERSATION operation.
-
folderID(optional):
string
The folder ID.
-
HM_ROOT(optional):
string
Hierarchical members root. Use to specify parentFolderID when parent should be the root.
-
impersonateUser(optional):
string
User to impersonate.
-
operationType(optional):
object XV1HierarchicalMembersOperationType
-
parentFolderID(optional):
string
The parent folder ID. Can be null. Will be ignored if parentUpdateInfo is set. Set parentUpdateInfo to null and parentFolderID to the folderID of the topmost folder in the ancestor hierarchy.
-
parentUpdateInfo(optional):
object XV1HierarchicalMembersUpdateInfo
V1 Collaboration API Hierarchical Members update DTO.
-
recurse(optional):
boolean
Used with the REMOVE_MEMBERS_OBJECT operation to mean remove recursively.
-
removedMemberGroups(optional):
array removedMemberGroups
List of removed groups. Can be empty. This can specify the group externalID, name or objectID.
-
removedMemberUserNames(optional):
array removedMemberUserNames
List of removed users. Can be empty.
Nested Schema : addedMemberGroups
Type:
array
List of added groups. Can be empty. This can specify the group externalID, name or objectID.
Show Source
-
Array of:
string
List of added groups. Can be empty. This can specify the group externalID, name or objectID.
Nested Schema : addedMemberUserNames
Type:
array
List of added users. Can be empty.
Show Source
-
Array of:
string
List of added users. Can be empty.
Nested Schema : childFolderIDs
Type:
array
List of child folder IDs. Can be empty. Use this to build up parent-child relationships within the member hierarchy.
Show Source
-
Array of:
string
List of child folder IDs. Can be empty. Use this to build up parent-child relationships within the member hierarchy.
Nested Schema : childUpdateInfos
Type:
array
List of child XV1HierarchicalMembersUpdateInfos.
Show Source
-
Array of:
object XV1HierarchicalMembersUpdateInfo
V1 Collaboration API Hierarchical Members update DTO.
Nested Schema : XV1HierarchicalMembersOperationType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
V1 Users and Groups API Operation Types on Hierarchical Members.
Nested Schema : removedMemberGroups
Type:
array
List of removed groups. Can be empty. This can specify the group externalID, name or objectID.
Show Source
-
Array of:
string
List of removed groups. Can be empty. This can specify the group externalID, name or objectID.
Nested Schema : removedMemberUserNames
Type:
array
List of removed users. Can be empty.
Show Source
-
Array of:
string
List of removed users. Can be empty.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1HierarchicalMembersInfo
Type:
object
V1 Hierarchical Members Information DTO.
Show Source
-
conversationAlreadyExists(optional):
boolean
Set to true if a conversation already exists when operationType is CREATE_CONVERSATION.
-
createdFolderIDs(optional):
object XV1FolderIDListInfo
List of folder IDs.
-
ignoredMembers(optional):
object XV1IgnoredMemberListInfo
List of ignored members.
-
ignoredUsers(optional):
object XV1IgnoredUserListInfo
List of ignored users.
-
operationType(optional):
object XV1HierarchicalMembersOperationType
-
removedFolderIDs(optional):
object XV1FolderIDListInfo
List of folder IDs.
Nested Schema : XV1FolderIDListInfo
Type:
object
List of folder IDs.
Show Source
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
ids(optional):
array ids
List of folder IDs.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : XV1IgnoredMemberListInfo
Type:
object
List of ignored members.
Show Source
-
groups(optional):
array groups
List of users.
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
-
users(optional):
array users
List of users.
Nested Schema : XV1IgnoredUserListInfo
Type:
object
List of ignored users.
Show Source
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
-
users(optional):
array users
List of users.
Nested Schema : XV1HierarchicalMembersOperationType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
V1 Users and Groups API Operation Types on Hierarchical Members.
Nested Schema : ids
Type:
array
List of folder IDs.
Show Source
-
Array of:
string
List of folder IDs.