機械翻訳について

移動先

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

指定した会話を更新

put

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

リクエスト

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

• application/json

パス・パラメータ

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

本文()

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

ルート・スキーマ: XV1ConversationUpdateInfo

型: object

V1会話更新情報。

ソースを表示

• impersonateUser(optional): string
  ユーザーを偽装します。
• updater(optional): object XConversationUpdater
  会話のアップデータ。

{
    "description":"V1 Conversation Update Information.",
    "properties":{
        "impersonateUser":{
            "description":"User to impersonate.",
            "type":"string"
        },
        "updater":{
            "$ref":"#/definitions/XConversationUpdater"
        }
    }
}

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

型: object

会話のアップデータ。

ソースを表示

• ALTITUDE(optional): string
  高度のdouble値。
• DATE_FORMAT_LOCALE(optional): string
  日付書式のロケール。
• DISALLOW_GUESTS(optional): string
  ゲストの拒否ステータスのboolean値。
• EXTENDED_ACCESS_CONTROL(optional): string
  拡張アクセス制御の使用ステータスのboolean値。
• fMap(optional): string
  含まれるマップ(文字列から値)。
• LANGUAGE_LOCALE(optional): string
  会話言語のロケール。
• LATITUDE(optional): string
  緯度のdouble値。
• LATITUDE_MAX(optional): number(double)
  可能な最大緯度。
• LATITUDE_MIN(optional): number(double)
  可能な最小緯度。
• LONGITUDE(optional): string
  経度のdouble値。
• LONGITUDE_MAX(optional): number(double)
  可能な最大経度。
• LONGITUDE_MIN(optional): number(double)
  可能な最小経度。
• MEMBERS_LOCKED(optional): string
  メンバーのロック・ステータスのboolean値。
• OUTCOME(optional): string
  結果の整数。(0-100)
• RETENTION_EXTENDED(optional): string
  この会話で拡張保持ポリシーを使用しているかどうかのboolean値。
• SHORT_NAME(optional): string
  短縮名の文字列。
• TIME_ZONE(optional): string
  タイムゾーン。

{
    "description":"Updater for conversations.",
    "properties":{
        "ALTITUDE":{
            "description":"Double for the altitude.",
            "type":"string"
        },
        "DISALLOW_GUESTS":{
            "description":"Boolean for disallow guests status.",
            "type":"string"
        },
        "EXTENDED_ACCESS_CONTROL":{
            "description":"Boolean for use extended access control status.",
            "type":"string"
        },
        "LATITUDE":{
            "description":"Double for the latitude.",
            "type":"string"
        },
        "LATITUDE_MAX":{
            "description":"Maximum possible latitude.",
            "type":"number",
            "format":"double"
        },
        "LATITUDE_MIN":{
            "description":"Minimum possible latitude.",
            "type":"number",
            "format":"double"
        },
        "LONGITUDE":{
            "description":"Double for the longitude.",
            "type":"string"
        },
        "LONGITUDE_MAX":{
            "description":"Maximum possible longitude.",
            "type":"number",
            "format":"double"
        },
        "LONGITUDE_MIN":{
            "description":"Minimum possible longitude.",
            "type":"number",
            "format":"double"
        },
        "MEMBERS_LOCKED":{
            "description":"Boolean for members locked status.",
            "type":"string"
        },
        "OUTCOME":{
            "description":"Integer for the outcome. (0-100)",
            "type":"string"
        },
        "SHORT_NAME":{
            "description":"String for the short name.",
            "type":"string"
        },
        "DATE_FORMAT_LOCALE":{
            "description":"The date-format locale.",
            "type":"string"
        },
        "LANGUAGE_LOCALE":{
            "description":"The spoken language locale.",
            "type":"string"
        },
        "RETENTION_EXTENDED":{
            "description":"Boolean for whether this conversation uses the extended retention policy.",
            "type":"string"
        },
        "TIME_ZONE":{
            "description":"The time zone.",
            "type":"string"
        },
        "fMap":{
            "description":"The contained Map of Strings to Values.",
            "type":"string"
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: XV1ConversationInfo

型: object

V1会話情報DTO。

ソースを表示

• allMembershipsURL(optional): string(url)
  この会話の階層メンバーシップへのURL。
• altitude(optional): number(double)
  オブジェクトの高度。
• archiveURL(optional): string(url)
  この会話のアーカイブへのURL。
• 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書式)。
• dateFormatLocale(optional): string(locale)
  この会話に適切な日付書式のロケール。
• discoverableID(optional):
  オブジェクトのlong integer表現の一意識別子。
• displayName(optional): string
  このオブジェクトの表示名。
• externalID(optional): string
  この会話のプライマリ外部ID。
• folderID(optional):
  オブジェクトのlong integer表現の一意識別子。
• folderURL(optional): string(url)
  この会話のルート・フォルダへのURL。
• gadgetsURL(optional): string(url)
  この会話のガジェットへのURL。
• hasMembersLocked(optional): boolean
  この会話のメンバーシップがロックされている場合はTrue。
• hierarchicalMembersInfo(optional): object XV1HierarchicalMembersInfo
  V1階層メンバー情報DTO。
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isDisallowGuests(optional): boolean
  この会話でゲスト・ユーザーが許可されていない場合はTrue。
• isDisallowOutsiders(optional): boolean
  この会話で部外者ユーザーが許可されていない場合はTrue。
• isDiscoverable(optional): boolean
  この会話が発見可能(public)であれば真。
• isExtendedAccessControl(optional): boolean
  この会話が拡張アクセス制御を使用している場合はTrue。
• isMuted(optional): boolean
  この会話が現在のユーザーにミュートされている場合はTrue。
• isNew(optional): boolean
  現在のユーザーがこの会話に参加したことがない場合はTrue。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• isScoped(optional): boolean
  この会話のメンバーシップが別の会話によって範囲指定されている場合はTrue。
• isScoping(optional): boolean
  これが範囲指定会話である場合はTrue。
• isScopingSame(optional): boolean
  この会話が別の会話と同じメンバーシップになるように範囲指定されている場合はTrue。
• languageLocale(optional): string(locale)
  この会話の言語ロケール。
• latitude(optional): number(double)
  オブジェクトの緯度。
• likesURL(optional): string(url)
  この会話のLIKEへのURL。
• longitude(optional): number(double)
  オブジェクトの経度。
• membershipsURL(optional): string(url)
  この会話のメンバーシップへのURL。
• membersURL(optional): string(url)
  この会話のメンバーへのURL。
• messagesURL(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
  このオブジェクトの名前。
• nChats(optional): integer(int32)
  この会話のチャット数。(チャット数を減らしてチャット数を減らしたもの)
• nFollowups(optional): integer(int32)
  会話のフォローアップの数。
• nMarkableChats(optional): integer(int32)
  既読としてマークできるチャットの数。 (マーク可能の合計から削除されたマーク可能を差し引きます。 現在のユーザーに依存しません)
• nOutsiders(optional): integer(int32)
  部外者ユーザーの数。
• nUnread(optional): integer(int32)
  現在のユーザーが既読としてマークできるチャットの数。
• objectType(optional): string
  このオブジェクトのタイプ。
• originalPictureURL(optional): string(url)
  元のピクチャのURL。
• profilePictureURL(optional): string(url)
  プロファイル・ピクチャのURL (150×150ピクセル)。
• propertiesURL(optional): string(url)
  この会話のプロパティへのURL。
• 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 (オプション): string
  この会話での現在のユーザーのロール。
• scaledPictureURL(optional): string(url)
  スケール調整済ピクチャのURL (44×44ピクセル)。
• secondaryExternalIDs(optional): array secondaryExternalIDs
  この会話のセカンダリ外部ID。
• securityContextID(optional): string
  この会話オブジェクトのセキュリティを規定するサービスのID。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• starsURL(optional): string(url)
  この会話の星印へのURL。
• state(optional): object XV1ConversationState
• timeZone(optional): string(timezone)
  この会話のタイムゾーン。
• url(optional): string(url)
  このオブジェクトへのURL。
• userPropertiesURL(optional): string(url)
  この会話のユーザー・プロパティへのURL。
• wallPostControl(optional): object XV1WallPostControlEnum

{
    "description":"V1 Conversation Information DTO.",
    "properties":{
        "allMembershipsURL":{
            "description":"A URL to the hierarchical memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "archiveURL":{
            "description":"A URL to the archive of this conversation.",
            "type":"string",
            "format":"url"
        },
        "dateFormatLocale":{
            "description":"The locale of the appropriate date format for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "discoverableID":{
            "$ref":"#/definitions/XObjectID"
        },
        "externalID":{
            "description":"The primary external ID of this conversation.",
            "type":"string"
        },
        "folderID":{
            "$ref":"#/definitions/XObjectID"
        },
        "folderURL":{
            "description":"A URL to the root folder of this conversation.",
            "type":"string",
            "format":"url"
        },
        "gadgetsURL":{
            "description":"A URL to the gadgets of this conversation.",
            "type":"string",
            "format":"url"
        },
        "hasMembersLocked":{
            "description":"True if the membership of this conversation is locked.",
            "type":"boolean"
        },
        "hierarchicalMembersInfo":{
            "$ref":"#/definitions/XV1HierarchicalMembersInfo"
        },
        "isDisallowGuests":{
            "description":"True if this conversation does not allow guest users.",
            "type":"boolean"
        },
        "isDisallowOutsiders":{
            "description":"True if this conversation does not allow outsider users.",
            "type":"boolean"
        },
        "isDiscoverable":{
            "description":"True if this conversation is discoverable (public).",
            "type":"boolean"
        },
        "isExtendedAccessControl":{
            "description":"True if this conversation uses extended access control.",
            "type":"boolean"
        },
        "isMuted":{
            "description":"True if this conversation is muted for the current user.",
            "type":"boolean"
        },
        "isNew":{
            "description":"True if this conversation has not been entered by the current user.",
            "type":"boolean"
        },
        "isScoped":{
            "description":"True if the membership of this conversation is scoped by another conversation.",
            "type":"boolean"
        },
        "isScoping":{
            "description":"True if this is a scoping conversation.",
            "type":"boolean"
        },
        "isScopingSame":{
            "description":"True if this conversation is scoped to have the same membership as another conversation.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"The language locale for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "likesURL":{
            "description":"A URL to the likes of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membershipsURL":{
            "description":"A URL to the memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membersURL":{
            "description":"A URL to the members of this conversation.",
            "type":"string",
            "format":"url"
        },
        "messagesURL":{
            "description":"A URL to the messages in this conversation.",
            "type":"string",
            "format":"url"
        },
        "nChats":{
            "description":"The number of chats in this conversation. (total chats less deleted chats.)",
            "type":"integer",
            "format":"int32"
        },
        "nFollowups":{
            "description":"The number of followups in the conversation.",
            "type":"integer",
            "format":"int32"
        },
        "nMarkableChats":{
            "description":"The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)",
            "type":"integer",
            "format":"int32"
        },
        "nOutsiders":{
            "description":"Count of the outside users.",
            "type":"integer",
            "format":"int32"
        },
        "nUnread":{
            "description":"The number of chats that the current user can mark read.",
            "type":"integer",
            "format":"int32"
        },
        "propertiesURL":{
            "description":"A URL to the properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "description":"The current user's role in this conversation.",
            "type":"string"
        },
        "secondaryExternalIDs":{
            "description":"The secondary external IDs for this conversation.",
            "type":"array",
            "items":{
                "description":"The secondary external IDs for this conversation.",
                "type":"string"
            }
        },
        "securityContextID":{
            "description":"The ID of the service that dictates the security for this conversation object.",
            "type":"string"
        },
        "starsURL":{
            "description":"A URL to the stars of this conversation.",
            "type":"string",
            "format":"url"
        },
        "state":{
            "$ref":"#/definitions/XV1ConversationState"
        },
        "timeZone":{
            "description":"The time zone for this conversation.",
            "type":"string",
            "format":"timezone"
        },
        "userPropertiesURL":{
            "description":"A URL to the user properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "wallPostControl":{
            "$ref":"#/definitions/XV1WallPostControlEnum"
        },
        "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"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

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

型: array

この会話のセカンダリ外部ID。

ソースを表示

• Array of: string
  この会話のセカンダリ外部ID。

{
    "description":"The secondary external IDs for this conversation.",
    "type":"array",
    "items":{
        "description":"The secondary external IDs for this conversation.",
        "type":"string"
    }
}

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

型: object

ソースを表示

• field(optional): string
  許容値: [ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]

  V1会話の状態。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation States.",
            "enum":[
                "CLOSED_CHAINED",
                "CLOSED_DISABLED",
                "CLOSED_DROPPED",
                "CLOSED_RESOLVED",
                "OPEN_ACTIVE"
            ]
        }
    }
}

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

型: object

ソースを表示

• field(optional): string
  許容値: [ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]

  V1壁ポスト制御列挙型。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Wall Posting Control Enum.",
            "enum":[
                "ANYONE_CAN_POST",
                "OWNER_ONLY_POSTS",
                "OWNER_TOP_LEVEL"
            ]
        }
    }
}

ネストされたスキーマ: 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"
    }
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースにPUTリクエストを送信し、指定した会話を更新する方法を示しています。

curl -X PUT -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:b97554e5a31e50a734899ee4f79218bd' -H 'Content-Type: application/json' https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006 -d '{ "updater" : {"State":"OPEN_ACTIVE", "Altitude":"15"}}'

リクエスト本文の例

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

{
  "updater" : {"State":"OPEN_ACTIVE", "Altitude":"15"}
}

レスポンス本文の例

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

"[e-mail]",
  "createdByUserDisplayName" : "[e-mail]",
  "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "createdDate" : 1455325485929,
  "modifiedByID" : "11001",
  "modifiedByUserName" : "[e-mail]",
  "modifiedByUserDisplayName" : "[e-mail]",
  "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "modifiedDate" : 1455326386743,
  "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" : 2,
  "nMarkableChats" : 1,
  "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"
}

先頭に戻る