機械翻訳について

移動

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

指定されたグループの直接メンバーを取得

get

/social/api/v1/groups/{groupID}/members

NOTE: 管理者は、グループ・メンバーに加えてグループ・メンバーシップにもアクセスできます。

リクエスト

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

• application/json

パス・パラメータ

• groupID: integer(int64)
  グループID。 オブジェクトのlong integer表現の一意識別子。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1GroupMemberListInfo

型: object

V1グループ・ダイレクト・メンバー・リスト情報DTO。

Show Source

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

{
    "description":"V1 Group Direct Member List Information DTO.",
    "properties":{
        "items":{
            "description":"The members being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1GroupMemberInfo"
            }
        },
        "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"
        }
    }
}

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

型: array

返されるメンバー。

Show Source

• Array of: object XV1GroupMemberInfo
  V1グループの直接メンバー情報DTO。

{
    "description":"The members being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1GroupMemberInfo"
    }
}

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

型: object

V1グループの直接メンバー情報DTO。

Show Source

• altitude(optional): number(double)
  オブジェクトの高度。
• collectionURL(optional): string(url)
  コレクションを含むこのオブジェクトのURLです。
• conversationURL(optional): string(url)
  このオブジェクトに含まれる会話へのURL。
• createdByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• createdByURL(optional): string(url)
  このオブジェクトを作成したユーザーへのURL。
• createdByUserDisplayName(optional): string
  このオブジェクトを作成したユーザーの表示名。
• createdByUserName(optional): string
  このオブジェクトを作成したユーザーの名前。
• createdDate(optional): string(date)
  このオブジェクトが作成された日付。
• createdDateInISO8601Format(optional): string
  このオブジェクトが作成された日付(ISO 8601書式)。
• displayName(optional): string
  このオブジェクトの表示名。
• groupURL(optional): string(url)
  グループを含むグループのURL。
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isDirect(optional): boolean
  メンバーの直接ステータス。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• latitude(optional): number(double)
  オブジェクトの緯度。
• longitude(optional): number(double)
  オブジェクトの経度。
• membersURL(optional): string(url)
  このグループのメンバーのURL。
• modifiedByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• modifiedByURL(optional): string(url)
  このオブジェクトを最後に変更したユーザーへのURL。
• modifiedByUserDisplayName(optional): string
  このオブジェクトを最後に変更したユーザーの表示名。
• modifiedByUserName(optional): string
  このオブジェクトを最後に変更したユーザーの名前。
• modifiedDate(optional): string(date)
  このオブジェクトが最後に変更された日付。
• modifiedDateInISO8601Format(optional): string
  このオブジェクトが最後に変更された日付(ISO 8601書式)。
• name(optional): string
  このオブジェクトの名前。
• objectType(optional): string
  このオブジェクトのタイプ。
• removedByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• removedByURL(optional): string(url)
  このオブジェクトを最後に削除したユーザーへのURL。
• removedByUserDisplayName(optional): string
  このオブジェクトを最後に削除したユーザーの表示名。
• removedByUserName(optional): string
  このオブジェクトを最後に削除したユーザーの名前。
• removedDate(optional): string(date)
  このオブジェクトが削除された日付。
• removedDateInISO8601Format(optional): string
  このオブジェクトが削除された日付(ISO 8601書式)。
• role(optional): object XV1ConversationRole
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "description":"V1 Group Direct Member Information DTO.",
    "properties":{
        "groupURL":{
            "description":"A URL to the containing group.",
            "type":"string",
            "format":"url"
        },
        "isDirect":{
            "description":"The member's direct status.",
            "type":"boolean"
        },
        "membersURL":{
            "description":"A URL to the members of this Group.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "$ref":"#/definitions/XV1ConversationRole"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

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

型: object

Show Source

• field(optional): string
  許容値: [ "ADMIN", "BYPASS", "CONTRIBUTOR", "DISCOVERER", "GROUP_MANAGER", "GROUP_MEMBER", "HOST", "MANAGER", "MEMBER", "MODERATOR", "NONE", "VIEWER" ]

  V1会話ロール。

  会話ロールは、会話への許可および非許可のアクセスを定義するために使用されます。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation Roles. <p/> Conversation roles are used to define grantable and nongrantable access to conversations.",
            "enum":[
                "ADMIN",
                "BYPASS",
                "CONTRIBUTOR",
                "DISCOVERER",
                "GROUP_MANAGER",
                "GROUP_MEMBER",
                "HOST",
                "MANAGER",
                "MEMBER",
                "MODERATOR",
                "NONE",
                "VIEWER"
            ]
        }
    }
}

トップに戻る