Jump to

• Request
• Response

Update or create the specified hierarchical members.

put

/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.

Body ()

The request body defines the details of the request.

Root Schema : XV1HierarchicalMembersUpdateInfo

Type: object

V1 Collaboration API Hierarchical Members update DTO.

Show Source

• addedMemberGroups: array addedMemberGroups
  List of added groups. Can be empty. This can specify the group externalID, name or objectID.
• addedMemberUserNames: array addedMemberUserNames
  List of added users. Can be empty.
• childFolderIDs: array childFolderIDs
  List of child folder IDs. Can be empty. Use this to build up parent-child relationships within the member hierarchy.
• childUpdateInfos: array childUpdateInfos
  List of child XV1HierarchicalMembersUpdateInfos.
• conversationID: integer(int64)
  The conversation ID for a file. To be used with the MOVE_FILE operation.
• EVERYONE_GROUP: string
  Canonical everyone group name.
• fileID: string
  The file ID. To be used with the MOVE_FILE operation.
• folderID: string
  The folder ID.
• HM_ROOT: string
  Hierarchical members root. Use to specify parentFolderID when parent should be the root.
• impersonateUser: string
  User to impersonate.
• operationType: object XV1HierarchicalMembersOperationType
• parentFolderID: 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: object XV1HierarchicalMembersUpdateInfo
  V1 Collaboration API Hierarchical Members update DTO.
• recurse: boolean
  Used with the REMOVE_MEMBERS_OBJECT operation to mean remove recursively.
• removedMemberGroups: array removedMemberGroups
  List of removed groups. Can be empty. This can specify the group externalID, name or objectID.
• removedMemberUserNames: array removedMemberUserNames
  List of removed users. Can be empty.

{
    "description":"V1 Collaboration API Hierarchical Members update DTO.",
    "properties":{
        "addedMemberGroups":{
            "description":"List of added groups. Can be empty.  This can specify the group externalID, name or objectID.",
            "type":"array",
            "items":{
                "description":"List of added groups. Can be empty.  This can specify the group externalID, name or objectID.",
                "type":"string"
            }
        },
        "addedMemberUserNames":{
            "description":"List of added users. Can be empty.",
            "type":"array",
            "items":{
                "description":"List of added users. Can be empty.",
                "type":"string"
            }
        },
        "childFolderIDs":{
            "description":"List of child folder IDs. Can be empty.   Use this to build up parent-child relationships within the member hierarchy.",
            "type":"array",
            "items":{
                "description":"List of child folder IDs. Can be empty.   Use this to build up parent-child relationships within the member hierarchy.",
                "type":"string"
            }
        },
        "childUpdateInfos":{
            "description":"List of child XV1HierarchicalMembersUpdateInfos.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1HierarchicalMembersUpdateInfo"
            }
        },
        "conversationID":{
            "description":"The conversation ID for a file. To be used with the MOVE_FILE operation.",
            "type":"integer",
            "format":"int64"
        },
        "EVERYONE_GROUP":{
            "description":"Canonical everyone group name.",
            "type":"string"
        },
        "fileID":{
            "description":"The file ID. To be used with the MOVE_FILE operation.",
            "type":"string"
        },
        "folderID":{
            "description":"The folder ID.",
            "type":"string"
        },
        "HM_ROOT":{
            "description":"Hierarchical members root.   Use to specify parentFolderID when parent should be the root.",
            "type":"string"
        },
        "impersonateUser":{
            "description":"User to impersonate.",
            "type":"string"
        },
        "operationType":{
            "$ref":"#/definitions/XV1HierarchicalMembersOperationType"
        },
        "parentFolderID":{
            "description":"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.",
            "type":"string"
        },
        "parentUpdateInfo":{
            "$ref":"#/definitions/XV1HierarchicalMembersUpdateInfo"
        },
        "recurse":{
            "description":"Used with the REMOVE_MEMBERS_OBJECT operation to mean remove  recursively.",
            "type":"boolean"
        },
        "removedMemberGroups":{
            "description":"List of removed groups. Can be empty.  This can specify the group externalID, name or objectID.",
            "type":"array",
            "items":{
                "description":"List of removed groups. Can be empty.  This can specify the group externalID, name or objectID.",
                "type":"string"
            }
        },
        "removedMemberUserNames":{
            "description":"List of removed users. Can be empty.",
            "type":"array",
            "items":{
                "description":"List of removed users. Can be empty.",
                "type":"string"
            }
        }
    }
}

Nested Schema : addedMemberGroups

Type: array

List of added groups. Can be empty. This can specify the group externalID, name or objectID.

Show Source

• [0]: string
  List of added groups. Can be empty. This can specify the group externalID, name or objectID.

{
    "description":"List of added groups. Can be empty.  This can specify the group externalID, name or objectID.",
    "type":"array",
    "items":{
        "description":"List of added groups. Can be empty.  This can specify the group externalID, name or objectID.",
        "type":"string"
    }
}

Nested Schema : addedMemberUserNames

Type: array

List of added users. Can be empty.

Show Source

• [0]: string
  List of added users. Can be empty.

{
    "description":"List of added users. Can be empty.",
    "type":"array",
    "items":{
        "description":"List of added users. Can be empty.",
        "type":"string"
    }
}

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

• [0]: string
  List of child folder IDs. Can be empty. Use this to build up parent-child relationships within the member hierarchy.

{
    "description":"List of child folder IDs. Can be empty.   Use this to build up parent-child relationships within the member hierarchy.",
    "type":"array",
    "items":{
        "description":"List of child folder IDs. Can be empty.   Use this to build up parent-child relationships within the member hierarchy.",
        "type":"string"
    }
}

Nested Schema : childUpdateInfos

Type: array

List of child XV1HierarchicalMembersUpdateInfos.

Show Source

• [0]: object XV1HierarchicalMembersUpdateInfo
  V1 Collaboration API Hierarchical Members update DTO.

{
    "description":"List of child XV1HierarchicalMembersUpdateInfos.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1HierarchicalMembersUpdateInfo"
    }
}

Nested Schema : XV1HierarchicalMembersOperationType

Type: object

Show Source

• field: string
  Allowed Values: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]

  V1 Collaboration API Operation Types on Hierarchical Members.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Collaboration API Operation Types on Hierarchical Members.",
            "enum":[
                "ASSOCIATE_CONVERSATION",
                "CREATE_CONVERSATION",
                "MOVE_FILE",
                "MOVE_FOLDER",
                "MOVE_MEMBERS",
                "REMOVE_MEMBERS",
                "REMOVE_MEMBERS_OBJECT",
                "SHARE_FOLDER"
            ]
        }
    }
}

Nested Schema : removedMemberGroups

Type: array

List of removed groups. Can be empty. This can specify the group externalID, name or objectID.

Show Source

• [0]: string
  List of removed groups. Can be empty. This can specify the group externalID, name or objectID.

{
    "description":"List of removed groups. Can be empty.  This can specify the group externalID, name or objectID.",
    "type":"array",
    "items":{
        "description":"List of removed groups. Can be empty.  This can specify the group externalID, name or objectID.",
        "type":"string"
    }
}

Nested Schema : removedMemberUserNames

Type: array

List of removed users. Can be empty.

Show Source

• [0]: string
  List of removed users. Can be empty.

{
    "description":"List of removed users. Can be empty.",
    "type":"array",
    "items":{
        "description":"List of removed users. Can be empty.",
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Hierarchical Members Information DTO.

Root Schema : XV1HierarchicalMembersInfo

Type: object

V1 Hierarchical Members Information DTO.

Show Source

• createdFolderIDs: object XV1FolderIDListInfo
  List of folder IDs.
• ignoredMembers: object XV1IgnoredMemberListInfo
  List of ignored members.
• ignoredUsers: object XV1IgnoredUserListInfo
  List of ignored users.
• operationType: object XV1HierarchicalMembersOperationType
• removedFolderIDs: object XV1FolderIDListInfo
  List of folder IDs.

{
    "description":"V1 Hierarchical Members Information DTO.",
    "properties":{
        "createdFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        },
        "ignoredMembers":{
            "$ref":"#/definitions/XV1IgnoredMemberListInfo"
        },
        "ignoredUsers":{
            "$ref":"#/definitions/XV1IgnoredUserListInfo"
        },
        "operationType":{
            "$ref":"#/definitions/XV1HierarchicalMembersOperationType"
        },
        "removedFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        }
    }
}

Nested Schema : XV1FolderIDListInfo

Type: object

List of folder IDs.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• ids: array ids
  List of folder IDs.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"List of folder IDs.",
    "properties":{
        "ids":{
            "description":"List of folder IDs.",
            "type":"array",
            "items":{
                "description":"List of folder IDs.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1IgnoredMemberListInfo

Type: object

List of ignored members.

Show Source

• groups: array groups
  List of users.
• hasMore: boolean
  If true, there are more items to be returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users: array users
  List of users.

{
    "description":"List of ignored members.",
    "properties":{
        "groups":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1IgnoredUserListInfo

Type: object

List of ignored users.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users: array users
  List of users.

{
    "description":"List of ignored users.",
    "properties":{
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1HierarchicalMembersOperationType

Type: object

Show Source

• field: string
  Allowed Values: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]

  V1 Collaboration API Operation Types on Hierarchical Members.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Collaboration API Operation Types on Hierarchical Members.",
            "enum":[
                "ASSOCIATE_CONVERSATION",
                "CREATE_CONVERSATION",
                "MOVE_FILE",
                "MOVE_FOLDER",
                "MOVE_MEMBERS",
                "REMOVE_MEMBERS",
                "REMOVE_MEMBERS_OBJECT",
                "SHARE_FOLDER"
            ]
        }
    }
}

Nested Schema : ids

Type: array

List of folder IDs.

Show Source

• [0]: string
  List of folder IDs.

{
    "description":"List of folder IDs.",
    "type":"array",
    "items":{
        "description":"List of folder IDs.",
        "type":"string"
    }
}

Nested Schema : groups

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• [0]: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}