機械翻訳について

新規会話を作成

post

/social/api/v1/conversations

リクエスト

サポートされているメディア・タイプ
本文()
リクエスト本文は、リクエストの詳細を定義します。
ルート・スキーマ: XV1ConversationCreateInfo
型: object
V1会話作成情報。
ソースを表示
ネストされたスキーマ: XV1HierarchicalMembersUpdateInfo
型: object
V1 Collaboration API階層メンバー更新DTO。
ソースを表示
ネストされたスキーマ : addedMemberGroups
型: array
追加されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
ソースを表示
  • 追加されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
ネストされたスキーマ: addedMemberUserNames
型: array
追加されたユーザーのリスト。 空も可。
ソースを表示
ネストされたスキーマ: childFolderIDs
型: array
子フォルダIDのリスト。 空も可。 メンバー階層内で親-子の関係を構築するために使用します。
ソースを表示
  • 子フォルダIDのリスト。 空も可。 メンバー階層内で親-子の関係を構築するために使用します。
ネストされたスキーマ: childUpdateInfos
型: array
子XV1HierarchicalMembersUpdateInfosのリスト。
ソースを表示
ネストされたスキーマ: XV1HierarchicalMembersOperationType
型: object
ソースを表示
  • 許容値: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
    階層ユーザーのV1ユーザーおよびグループAPI操作のタイプ。
ネストされたスキーマ : removedMemberGroups
型: array
削除されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
ソースを表示
  • 削除されたグループのリスト。 空も可。 これは、グループexternalID、nameまたはobjectIDを指定できます。
ネストされたスキーマ: removedMemberUserNames
型: array
削除されたユーザーのリスト。 空も可。
ソースを表示
トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ: 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リソースにPOSTリクエストを発行して新しい会話を作成する方法を示しています。

curl -X POST -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:6ad1e16c57bdd307010f30eb132e2188' -H 'Content-Type: application/json' -d '{ "name" : "conv5 from curl exampl" ,"externalID" : "ext00055" }' https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations

リクエスト本文の例

JSON形式のリクエスト・ドキュメントの例を次に示します。

{
  "altitude": decimal number,
  "discoverableID": Object ID,
  "externalID": "text",
  "hasMembersLocked": false,
  "isDisallowGuests": false,
  "isDiscoverable": false,
  "isExtendedAccessControl": false,
  "isOwnerHidden": false,
  "isOwnerLocked": false,
  "isOwnerNotMember": false,
  "isScoping": false,
  "latitude": decimal number,
  "longitude": decimal number,
  "name": "text"
}

レスポンス本文の例

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

{
  "id" : "22006",
  "name" : "conv5 from curl exampl",
  "objectType" : "waggle/conversation",
  "createdByID" : "11001",
  "createdByUserName" : "jeff.pringle@example.com",
  "createdByUserDisplayName" : "jeff.pringle@example.com",
  "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "createdDate" : 1455325485929,
  "modifiedByID" : "11001",
  "modifiedByUserName" : "jeff.pringle@example.com",
  "modifiedByUserDisplayName" : "jeff.pringle@example.com",
  "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "modifiedDate" : 1455325485929,
  "isRemoved" : false,
  "url" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006",
  "externalID" : "ext00055",
  "secondaryExternalIDs" : ["ext00055"],
  "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" : "22011",
  "role" : "HOST",
  "isMuted" : false,
  "isNew" : true,
  "nChats" : 0,
  "nMarkableChats" : 0,
  "nUnread" : 0,
  "nFollowups" : 0,
  "membersURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/members",
  "membershipsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/memberships",
  "messagesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/messages",
  "propertiesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/properties",
  "userPropertiesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/userProperties",
  "starsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/stars",
  "likesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/likes",
  "gadgetsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/gadgets",
  "archiveURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/archive",
  "folderURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/folders/22011"
}
先頭に戻る