機械翻訳について

移動先

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

指定した会話のすべてのメンバーを取得

get

/social/api/v1/conversations/{conversationID}/allmemberships

リクエスト

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

• application/json

パス・パラメータ

• conversationID: integer(int64)
  会話ID。 オブジェクトのlong integer表現の一意識別子。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: XV1ConversationMemberListInfo

型: object

V1会話直接メンバー・リスト情報DTO。

ソースを表示

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

返されるメンバー。

ソースを表示

• Array of: object XV1ConversationMemberInfo
  V1会話直接メンバー情報DTO。

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

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

型: object

V1会話直接メンバー情報DTO。

ソースを表示

• 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
  このオブジェクトの表示名。
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isDirect(optional): boolean
  メンバーの直接ステータス。
• isHidden(optional): boolean
  メンバーの非表示ステータス。
• isHierarchical(optional): boolean
  メンバーの階層ステータス。
• isLocked(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
  このオブジェクトのタイプ。
• originalPictureURL(optional): string(url)
  元のピクチャのURL。
• profilePictureURL(optional): string(url)
  プロファイル・ピクチャのURL (150×150ピクセル)。
• 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
• scaledPictureURL(optional): string(url)
  スケール調整済ピクチャのURL (44×44ピクセル)。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "description":"V1 Conversation Direct Member Information DTO.",
    "properties":{
        "isDirect":{
            "description":"The member's direct status.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"The member's hidden status.",
            "type":"boolean"
        },
        "isHierarchical":{
            "description":"The member's hierarchical status.",
            "type":"boolean"
        },
        "isLocked":{
            "description":"The member's locked status.",
            "type":"boolean"
        },
        "membersURL":{
            "description":"A URL to the collection of members.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "$ref":"#/definitions/XV1ConversationRole"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "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

ソースを表示

• 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"
            ]
        }
    }
}

先頭に戻る