機械翻訳について

移動先

• リクエスト
• レスポンス

指定された階層メンバーを更新または作成します。

put

/social/api/v1/hierarchicalMembers/{hierarchicalMemberID}

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• hierarchicalMemberID: integer(int64)
  階層メンバーID。 オブジェクトのlong integer表現の一意識別子。

本文()

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ : XV1HierarchicalMembersUpdateInfo

型: object

V1 Collaboration API階層メンバー更新DTO。

ソースを表示

• addedMemberGroups(optional): array addedMemberGroups
  追加されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
• addedMemberUserNames(optional): array addedMemberUserNames
  追加されたユーザーのリスト。 空も可。
• childFolderIDs(optional): array childFolderIDs
  子フォルダIDのリスト。 空も可。 メンバー階層内で親-子の関係を構築するために使用します。
• childUpdateInfos(optional): array childUpdateInfos
  子XV1HierarchicalMembersUpdateInfosのリスト。
• conversationID(optional): integer(int64)
  ファイルの会話ID。 MOVE_FILE操作で使用します。
• EVERYONE_GROUP(optional): string
  正式な皆グループ名。
• fileID(optional): string
  ファイルID。 MOVE_FILE操作で使用します。
• findOrCreateConversation(optional): boolean
  trueに設定すると、CREATE_CONVERSATION操作の既存の会話が見つかります。
• folderID(optional): string
  フォルダID。
• HM_ROOT(optional): string
  階層メンバーのルート。 親がルートの場合にparentFolderIDを指定するために使用します。
• impersonateUser(optional): string
  ユーザーを偽装します。
• operationType(optional): object XV1HierarchicalMembersOperationType
• parentFolderID(optional): string
  親フォルダID。 nullも可。 parentUpdateInfoが設定されている場合は無視されます。 parentUpdateInfoをnullに設定し、parentFolderIDを祖先階層の最上位フォルダのfolderIDに設定します。
• parentUpdateInfo(optional): object XV1HierarchicalMembersUpdateInfo
  V1 Collaboration API階層メンバー更新DTO。
• recurse(optional): boolean
  REMOVE_MEMBERS_OBJECT操作で使用すると、再帰的な削除を意味します。
• removedMemberGroups(optional): array removedMemberGroups
  削除されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
• removedMemberUserNames(optional): array removedMemberUserNames
  削除されたユーザーのリスト。 空も可。

{
    "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"
        },
        "findOrCreateConversation":{
            "description":"If set true will find an existing conversation for  the CREATE_CONVERSATION operation.",
            "type":"boolean"
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : addedMemberGroups

型: array

追加されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。

ソースを表示

• Array of: string
  追加されたグループのリスト。 空も可。 これは、グループexternalID、nameまたは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"
    }
}

ネストされたスキーマ: addedMemberUserNames

型: array

追加されたユーザーのリスト。 空も可。

ソースを表示

• Array of: string
  追加されたユーザーのリスト。 空も可。

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

ネストされたスキーマ: childFolderIDs

型: array

子フォルダIDのリスト。 空も可。 メンバー階層内で親-子の関係を構築するために使用します。

ソースを表示

• Array of: string
  子フォルダIDのリスト。 空も可。 メンバー階層内で親-子の関係を構築するために使用します。

{
    "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

型: array

子XV1HierarchicalMembersUpdateInfosのリスト。

ソースを表示

• Array of: object XV1HierarchicalMembersUpdateInfo
  V1 Collaboration API階層メンバー更新DTO。

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

ネストされたスキーマ: XV1HierarchicalMembersOperationType

型: object

ソースを表示

• field(optional): string
  許容値: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]

  階層ユーザーのV1ユーザーおよびグループAPI操作のタイプ。

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

ネストされたスキーマ : removedMemberGroups

型: array

削除されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。

ソースを表示

• Array of: string
  削除されたグループのリスト。 空も可。 これは、グループexternalID、nameまたは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"
    }
}

ネストされたスキーマ: removedMemberUserNames

型: array

削除されたユーザーのリスト。 空も可。

ソースを表示

• Array of: string
  削除されたユーザーのリスト。 空も可。

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1HierarchicalMembersInfo

型: object

V1階層メンバー情報DTO。

ソースを表示

• conversationAlreadyExists(optional): boolean
  operationTypeがCREATE_CONVERSATIONの場合、会話がすでに存在する場合はtrueに設定します。
• createdFolderIDs(optional): object XV1FolderIDListInfo
  フォルダIDのリスト。
• ignoredMembers(optional): object XV1IgnoredMemberListInfo
  無視されたメンバーのリスト。
• ignoredUsers(optional): object XV1IgnoredUserListInfo
  無視されたユーザーのリスト。
• operationType(optional): object XV1HierarchicalMembersOperationType
• removedFolderIDs(optional): object XV1FolderIDListInfo
  フォルダIDのリスト。

{
    "description":"V1 Hierarchical Members Information DTO.",
    "properties":{
        "conversationAlreadyExists":{
            "description":"Set to true if a conversation already exists when  operationType is CREATE_CONVERSATION.",
            "type":"boolean"
        },
        "createdFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        },
        "ignoredMembers":{
            "$ref":"#/definitions/XV1IgnoredMemberListInfo"
        },
        "ignoredUsers":{
            "$ref":"#/definitions/XV1IgnoredUserListInfo"
        },
        "operationType":{
            "$ref":"#/definitions/XV1HierarchicalMembersOperationType"
        },
        "removedFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        }
    }
}

ネストされたスキーマ: XV1FolderIDListInfo

型: object

フォルダIDのリスト。

ソースを表示

• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• ids(optional): array ids
  フォルダIDのリスト。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。

{
    "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"
        }
    }
}

ネストされたスキーマ : XV1IgnoredMemberListInfo

型: object

無視されたメンバーのリスト。

ソースを表示

• groups(optional): array groups
  ユーザーのリスト。
• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
• users(optional): array 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"
        }
    }
}

ネストされたスキーマ: XV1IgnoredUserListInfo

型: object

無視されたユーザーのリスト。

ソースを表示

• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
• users(optional): array 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"
        }
    }
}

ネストされたスキーマ: XV1HierarchicalMembersOperationType

型: object

ソースを表示

• field(optional): string
  許容値: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]

  階層ユーザーのV1ユーザーおよびグループAPI操作のタイプ。

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

ネストされたスキーマ: ids

型: array

フォルダIDのリスト。

ソースを表示

• Array of: string
  フォルダIDのリスト。

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

ネストされたスキーマ: groups

型: array

ユーザーのリスト。

ソースを表示

• Array of: string
  ユーザーのリスト。

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

ネストされたスキーマ: users

型: array

ユーザーのリスト。

ソースを表示

• Array of: string
  ユーザーのリスト。

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

ネストされたスキーマ: users

型: array

ユーザーのリスト。

ソースを表示

• Array of: string
  ユーザーのリスト。

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

先頭に戻る