機械翻訳について
  1. 会話のためのREST API
  2. タスク
  3. コラボレーション

すべての会話のフィルタされたリストを取得

get

/social/api/v1/conversations

リクエスト

サポートされているメディア・タイプ
本文()
問合せ対象のフィルタを指定します。
ルート・スキーマ: XV1ConversationFilterInfo
型: object
V1会話フィルタ情報。
ソースを表示
  • オブジェクトのlong integer表現の一意識別子。
  • クローズした会話を除外するにはtrueを設定します。 excludeOpenとexcludeClosedの両方にtrueを指定すると、会話は返されません。
  • 未読のメッセージがない会話を除外するにはtrueを設定します。
  • このユーザーが直接または間接メンバーである会話を除外するにはtrueを設定します。 includeDiscoverableにfalseを指定し、excludeMemberedにtrueを指定すると、会話は返されません。
  • ミュートされた会話を除外するにはtrueを設定します。 excludeMutedとlimitToMutedの両方にtrueを設定することは無意味です。
  • 1対1の会話を除外するにはtrueを設定します。 excludeOneOnOneとlimitToOneOnOneの両方にtrueを設定することは無意味です。
  • オープン中の会話を除外するにはtrueを設定します。 excludeOpenとexcludeClosedの両方にtrueを指定すると、会話は返されません。
  • ウォール会話を除外するにはtrueを設定します。 excludeWallsとlimitToWallsの両方にtrueを設定することは無意味です。
  • LimitToUserWallsまたはLimitToGroupWallsとともに使用して、戻されるウォールを、所有メンバー(ユーザーまたはグループ)が有効化または無効化されているウォールに制限します。 これらのブール値のどちらも指定しない場合、選択したすべてのウォールが返されます。
  • 検出可能な会話を含めるにはtrueを設定します。 includeDiscoverableにfalseを指定し、excludeMemberedにtrueを指定すると、会話は返されません。
  • LimitToUserWallsまたはLimitToGroupWallsとともに使用して、戻されるウォールを、所有メンバー(ユーザーまたはグループ)が有効化または無効化されているウォールに制限します。 これらのブール値のどちらも指定しない場合、選択したすべてのウォールが返されます。
  • limitToGadgetID、limitToGadgetIDsまたはlimitToGadgetGroupを指定した場合に、直接関連する会話も返すように指定します。
  • アクティブな会議がある会話に限定します。
  • オブジェクトのlong integer表現の一意識別子。
  • オブジェクトのlong integer表現の一意識別子。
  • 指定したタイプのガジェットExternalIDの会話に限定します。 limitToGadgetID、limitToGadgetIDsまたはlimitToGadgetGroupと一緒には指定しないでください。
  • 指定したタイプのガジェット・グループの会話に限定します。 limitToGadgetID、limitToGadgetIDsまたはlimitToGadgetExternalIDと一緒には指定しないでください。
  • オブジェクトのlong integer表現の一意識別子。
  • limitToGadgetIDs
    指定したタイプのガジェットIDの会話に限定します。 limitToGadgetID、limitToGadgetGroupまたはlimitToGadgetExternalIDと一緒には指定しないでください。
  • 結果をグループ・ウォールの会話に制限します。 limitToGroupWallsとlimitToUserWallsまたはlimitToGroupWallsとlimitToOneOnOneの両方をtrueに設定するのは意味がありません。
  • 現在のユーザーがLIKEを設定した会話に限定します。
  • ミュートされた会話に限定するにはtrueを設定します。 excludeMutedとlimitToMutedの両方にtrueを設定することは無意味です。
  • n以上のユーザーがLIKEを設定している会話に限定します。

    nullを指定した場合、チェックは実行されません。その他の場合、会話には指定した数以上のユーザーがLIKEを設定している必要があります。

  • n以上のユーザーが星印を付けている会話に限定します。

    nullを指定した場合、チェックは実行されません。その他の場合、会話には指定した数以上のユーザーが星印を付けている必要があります。

  • 結果を1対1の会話に限定します。 limitToOneOnOneとlimitToUserWallsまたはlimitToOneOnOneとlimitToGroupWallsの両方をtrueに設定するのは意味がありません。
  • 非推奨。v2では削除される予定です。
  • 非推奨。v2では削除される予定です。
  • sortFieldを次のいずれかとして指定し、このブールがtrueの場合、ソート値がゼロ(0)より大きい会話のみに結果が制限されます。 
        CONVERSATION_IS_NEW    CONVERSATION_N_MESSAGES    CONVERSATION_N_MESSAGES_UNREAD    CONVERSATION_N_ENTERED    CONVERSATION_N_FOLLOWUPS    CONVERSATION_ACTIVITY    CONVERSATION_CONFERENCES
  • SortFieldが次のいずれかに指定されている場合、この日付が指定されている場合、ソート値がより新しい(より新しい)会話のみに結果が制限されます。 
          CONVERSATION_CREATED_DATE      CONVERSATION_LAST_POST
  • 現在のユーザーが星印を付けた会話に限定します。
  • 結果をユーザー・ウォールの会話に制限します。 limitToUserWallsとlimitToGroupWallsまたはlimitToUserWallsとlimitToOneOnOneの両方をtrueに設定することは意味がありません。
  • ウォール会話のみを含めるには、trueを設定します。 excludeWallsとlimitToWallsの両方にtrueを設定することは無意味です。
  • XV1ConversationSortField
  • ソートは降順です。
ネストされたスキーマ: limitToGadgetIDs
型: array
指定したタイプのガジェットIDの会話に限定します。 limitToGadgetID、limitToGadgetGroupまたはlimitToGadgetExternalIDと一緒には指定しないでください。
ソースを表示
  • オブジェクトのlong integer表現の一意識別子。
ネストされたスキーマ: XV1ConversationSortField
型: object
ソースを表示
  • 許可された値: [ "CONVERSATION_ACTIVITY", "CONVERSATION_CONFERENCES", "CONVERSATION_CREATED_DATE", "CONVERSATION_IS_NEW", "CONVERSATION_LAST_POST", "CONVERSATION_N_ENTERED", "CONVERSATION_N_FOLLOWUPS", "CONVERSATION_N_MESSAGES", "CONVERSATION_N_MESSAGES_UNREAD", "CONVERSATION_NAME", "CONVERSATION_STATE", "CONVERSATION_TYPE" ]
    V1会話ソート・フィールド。
トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ: XV1ConversationListInfo
型: object
V1会話リスト情報DTO。
ソースを表示
ネストされたスキーマ: items
型: array
返される会話。
ソースを表示
ネストされたスキーマ: XV1ConversationInfo
型: object
V1会話情報DTO。
ソースを表示
ネストされたスキーマ: XV1HierarchicalMembersInfo
型: object
V1階層メンバー情報DTO。
ソースを表示
ネストされたスキーマ: secondaryExternalIDs
型: array
この会話のセカンダリ外部ID。
ソースを表示
ネストされたスキーマ: XV1ConversationState
型: object
ソースを表示
  • 許容値: [ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]
    V1会話の状態。
ネストされたスキーマ: XV1WallPostControlEnum
型: object
ソースを表示
  • 許容値: [ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]
    V1壁ポスト制御列挙型。
ネストされたスキーマ: XV1FolderIDListInfo
型: object
フォルダIDのリスト。
ソースを表示
ネストされたスキーマ : XV1IgnoredMemberListInfo
型: object
無視されたメンバーのリスト。
ソースを表示
ネストされたスキーマ: XV1IgnoredUserListInfo
型: object
無視されたユーザーのリスト。
ソースを表示
ネストされたスキーマ: XV1HierarchicalMembersOperationType
型: object
ソースを表示
  • 許容値: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
    階層ユーザーのV1ユーザーおよびグループAPI操作のタイプ。
ネストされたスキーマ: ids
型: array
フォルダIDのリスト。
ソースを表示
ネストされたスキーマ: groups
型: array
ユーザーのリスト。
ソースを表示
ネストされたスキーマ: users
型: array
ユーザーのリスト。
ソースを表示
ネストされたスキーマ: users
型: array
ユーザーのリスト。
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースにGETリクエストを送信し、すべての会話のフィルタされたリストを取得する方法を示しています。

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:22a8a2ca707602ae2da3512e0ca28a06' -H 'Content-Type: application/json'  https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations

次の例には問合せフィルタ・パラメータが含まれています。

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:22a8a2ca707602ae2da3512e0ca28a06' -H 'Content-Type: application/json' 'https://socialnetwork06065-ustraveler1592.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations?filter={"excludeClosed":true,"excludeFullyRead":true}'

レスポンス本文の例

レスポンスJSONドキュメントの例を次に示します。

{
  "hasMore" : false,
  "items" : 
  [
   {
    "id": "45029",
    "name": "text",
    "objectType": "waggle/conversation",
    "createdByID": "24114",
    "createdByUserName": "dsmith@example.com",
    "createdByUserDisplayName": "Rosanna Channing",
    "createdDate": "Thu, 03 Sep 2015 14:39:22 GMT",
    "modifiedByID": "24114",
    "modifiedByUserName": "dsmith@example.com",
    "modifiedByUserDisplayName": "Rosanna Channing",
    "modifiedDate": "Thu, 03 Sep 2015 14:39:22 GMT",
    "isRemoved": "false",
    "latitude": "11",
    "longitude": "11",
    "altitude": "1",
    "externalID": "text",
    "secondaryExternalIDs":
    ["a text",    ]
    "isScoping": "false",
    "isScopingSame": "false",
    "isScoped": "false",
    "state": "OPEN_ACTIVE",
    "isDiscoverable": "false",
    "wallPostControl": "ANYONE_CAN_POST",
    "hasMembersLocked": "false",
    "isDisallowGuests": "false",
    "isDisallowOutsiders": "false",
    "nOutsiders": "0",
    "isExtendedAccessControl": "false",
    "folderID": "45034",
    "role": "HOST",
    "isMuted": "false",
    "isNew": "false",
    "nChats": "7",
    "nMarkableChats": "5",
    "nUnread": "0",
    "nFollowups": "0",
   },
   {
    "id": "689280",
    "name": "A Warm Welcome to the Team",
    "objectType": "waggle/conversation",
    "createdByID": "24114",
    "createdByUserName": "dsmith@example.com",
    "createdByUserDisplayName": "Rosanna Channing",
    "createdDate": "Thu, 22 Oct 2015 22:40:49 GMT",
    "modifiedByID": "24114",
    "modifiedByUserName": "dsmith@example.com",
    "modifiedByUserDisplayName": "Rosanna Channing",
    "modifiedDate": "Thu, 22 Oct 2015 22:40:49 GMT",
    "isRemoved": "false",
    "secondaryExternalIDs":
    "isScoping": "false",
    "isScopingSame": "false",
    "isScoped": "false",
    "state": "OPEN_ACTIVE",
    "isDiscoverable": "true",
    "wallPostControl": "ANYONE_CAN_POST",
    "hasMembersLocked": "false",
    "isDisallowGuests": "false",
    "isDisallowOutsiders": "false",
    "nOutsiders": "0",
    "isExtendedAccessControl": "false",
    "folderID": "689285",
    "role": "HOST",
    "isMuted": "false",
    "isNew": "false",
    "nChats": "8",
    "nMarkableChats": "5",
    "nUnread": "1",
    "nFollowups": "0",
   }
  ] 
}
先頭に戻る