Associate a document with the specified conversation.
post
/social/api/v1/conversations/{conversationID}/associate
Request
Supported Media Types
- application/json
Path Parameters
-
conversationID: integer(int64)
The conversation ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1ContentServerDocumentUploadInfo
Type:
object
V1 Document Associate Information.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
chatMessage(optional):
string
The associated chat message for this content. If the value is null, then a system message will be generated.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
contentServerDocumentGUID(optional):
string
GUID of document in the content server.
-
contentServerDocumentVersion(optional):
string
Version of the document from the content server.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
displayName(optional):
string
The display name of this object.
-
id(optional):
An object's unique identifier from a long integer representation.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
url(optional):
string(url)
A URL to this object.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1DocumentAssociateInfo
Type:
object
V1 Associate Document Information DTO.
Show Source
-
contentMimeType(optional):
string
Content mime type.
-
contentName(optional):
string
Document display name.
-
createdTimestamp(optional):
string(date)
Document associate time.
-
modifiedTimestamp(optional):
string(date)
Document modification time.
-
name(optional):
string
Document name.
-
versionInfo(optional):
object XV1VersionInfo
V1 Version Information DTO.
Nested Schema : XV1VersionInfo
Type:
object
V1 Version Information DTO.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
associatedWithChatID(optional):
An object's unique identifier from a long integer representation.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
contentLength(optional):
integer(int64)
The content length.
-
contentType(optional):
string
The content type.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
displayName(optional):
string
The display name of this object.
-
downloadURL(optional):
string(url)
The document download URL.
-
folderURL(optional):
string(url)
The containing folder URL.
-
id(optional):
An object's unique identifier from a long integer representation.
-
isBusy(optional):
boolean
The content is busy.
-
isLocked(optional):
boolean
The content is locked.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
messageURL(optional):
string(url)
Any associated message URL.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
nPages(optional):
integer(int32)
The number of rendered pages.
-
objectType(optional):
string
The type of this object.
-
pageURLs(optional):
array pageURLs
The document page URLs.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
thumbnailURL(optional):
string(url)
The document thumbnail URL.
-
url(optional):
string(url)
A URL to this object.
Nested Schema : pageURLs
Type:
array
The document page URLs.
Show Source
-
Array of:
string(url)
The document page URLs.