機械翻訳について

移動先

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

ドキュメントを指定された会話に関連付けます。

post

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

リクエスト

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

• application/json

パス・パラメータ

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

本文()

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

ルート・スキーマ : XV1ContentServerDocumentUploadInfo

型: object

V1ドキュメント関連付け情報。

ソースを表示

• altitude(optional): number(double)
  オブジェクトの高度。
• chatMessage(optional): string
  このコンテンツに関連付けられたチャット・メッセージ。 値がNULLの場合は、システム・メッセージが生成されます。
• collectionURL(optional): string(url)
  コレクションを含むこのオブジェクトのURL。
• contentServerDocumentGUID(optional): string
  コンテンツ・サーバー内のドキュメントのGUID。
• contentServerDocumentVersion(optional): string
  コンテンツ・サーバーからの文書のバージョン。
• 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表現の一意識別子。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• latitude(optional): number(double)
  オブジェクトの緯度。
• longitude(optional): number(double)
  オブジェクトの経度。
• 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書式)。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "description":"V1 Document Associate Information.",
    "properties":{
        "chatMessage":{
            "description":"The associated chat message for this content. If the value  is null, then a system message will be generated.",
            "type":"string"
        },
        "contentServerDocumentGUID":{
            "description":"GUID of document in the content server.",
            "type":"string"
        },
        "contentServerDocumentVersion":{
            "description":"Version of the document from the content server.",
            "type":"string"
        },
        "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"
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1DocumentAssociateInfo

型: object

V1文書情報の関連付けDTO。

ソースを表示

• contentMimeType(optional): string
  コンテンツMIMEタイプ。
• contentName(optional): string
  ドキュメント表示名。
• createdTimestamp(optional): string(date)
  ドキュメントの関連付け時間。
• modifiedTimestamp(optional): string(date)
  文書変更時間。
• name(optional): string
  ドキュメント名
• versionInfo(optional): object XV1VersionInfo
  V1バージョン情報DTO。

{
    "description":"V1 Associate Document Information DTO.",
    "properties":{
        "contentMimeType":{
            "description":"Content mime type.",
            "type":"string"
        },
        "contentName":{
            "description":"Document display name.",
            "type":"string"
        },
        "createdTimestamp":{
            "description":"Document associate time.",
            "type":"string",
            "format":"date"
        },
        "modifiedTimestamp":{
            "description":"Document modification time.",
            "type":"string",
            "format":"date"
        },
        "name":{
            "description":"Document name.",
            "type":"string"
        },
        "versionInfo":{
            "$ref":"#/definitions/XV1VersionInfo"
        }
    }
}

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

型: object

V1バージョン情報DTO。

ソースを表示

• altitude(optional): number(double)
  オブジェクトの高度。
• associatedWithChatID(optional):
  オブジェクトのlong integer表現の一意識別子。
• collectionURL(optional): string(url)
  コレクションを含むこのオブジェクトのURL。
• contentLength(optional): integer(int64)
  コンテンツの長さです。
• contentType(optional): string
  コンテンツ・タイプ。
• 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
  このオブジェクトの表示名。
• downloadURL(optional): string(url)
  ドキュメント・ダウンロードURL。
• folderURL(optional): string(url)
  格納フォルダURL。
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isBusy(optional): boolean
  コンテンツがビジー状態です。
• isLocked(optional): boolean
  コンテンツがロックされています。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• latitude(optional): number(double)
  オブジェクトの緯度。
• longitude(optional): number(double)
  オブジェクトの経度。
• messageURL(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
  このオブジェクトの名前。
• nPages(optional): integer(int32)
  レンダリングされたページの数。
• objectType(optional): string
  このオブジェクトのタイプ。
• pageURLs(optional): array pageURLs
  ドキュメント・ページの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書式)。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• thumbnailURL(optional): string(url)
  ドキュメントのサムネイルURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "description":"V1 Version Information DTO.",
    "properties":{
        "associatedWithChatID":{
            "$ref":"#/definitions/XObjectID"
        },
        "contentLength":{
            "description":"The content length.",
            "type":"integer",
            "format":"int64"
        },
        "contentType":{
            "description":"The content type.",
            "type":"string"
        },
        "downloadURL":{
            "description":"The document download URL.",
            "type":"string",
            "format":"url"
        },
        "folderURL":{
            "description":"The containing folder URL.",
            "type":"string",
            "format":"url"
        },
        "isBusy":{
            "description":"The content is busy.",
            "type":"boolean"
        },
        "isLocked":{
            "description":"The content is locked.",
            "type":"boolean"
        },
        "messageURL":{
            "description":"Any associated message URL.",
            "type":"string",
            "format":"url"
        },
        "nPages":{
            "description":"The number of rendered pages.",
            "type":"integer",
            "format":"int32"
        },
        "pageURLs":{
            "description":"The document page URLs.",
            "type":"array",
            "items":{
                "description":"The document page URLs.",
                "type":"string",
                "format":"url"
            }
        },
        "thumbnailURL":{
            "description":"The document thumbnail URL.",
            "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"
        }
    }
}

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

型: array

ドキュメント・ページのURL。

ソースを表示

• Array of: string(url)
  ドキュメント・ページのURL。

{
    "description":"The document page URLs.",
    "type":"array",
    "items":{
        "description":"The document page URLs.",
        "type":"string",
        "format":"url"
    }
}

先頭に戻る