Jump to

• Request
• Response

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.

Body ()

The request body defines the details of the request.

Root Schema : XV1ContentServerDocumentUploadInfo

Type: object

V1 Document Associate Information.

Show Source

• altitude: number(double)
  The object's altitude.
• chatMessage: string
  The associated chat message for this content. If the value is null then a system message will be generated.
• collectionURL: string(url)
  A URL to this object's containing collection.
• contentServerDocumentGUID: string
  GUID of document in the content server.
• contentServerDocumentVersion: string
  Version of the document from the content server.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• displayName: string
  The display name of this object.
• id:
  An object's unique identifier from a long integer representation.
• isRemoved: boolean
  True if this message has been removed.
• latitude: number(double)
  The object's latitude.
• longitude: number(double)
  The object's longitude.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• objectType: string
  The type of this object.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• url: string(url)
  A URL to this object.

{
    "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"
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Associate Document Information DTO.

Root Schema : XV1DocumentAssociateInfo

Type: object

V1 Associate Document Information DTO.

Show Source

• contentMimeType: string
  Content mime type.
• contentName: string
  Document display name.
• createdTimestamp: string(date)
  Document associate time.
• modifiedTimestamp: string(date)
  Document modification time.
• name: string
  Document name.
• versionInfo: object XV1VersionInfo
  V1 Version Information 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"
        }
    }
}

Nested Schema : XV1VersionInfo

Type: object

V1 Version Information DTO.

Show Source

• altitude: number(double)
  The object's altitude.
• associatedWithChatID:
  An object's unique identifier from a long integer representation.
• collectionURL: string(url)
  A URL to this object's containing collection.
• contentLength: integer(int64)
  The content length.
• contentType: string
  The content type.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• displayName: string
  The display name of this object.
• downloadURL: string(url)
  The document download URL.
• folderURL: string(url)
  The containing folder URL.
• id:
  An object's unique identifier from a long integer representation.
• isBusy: boolean
  The content is busy.
• isLocked: boolean
  The content is locked.
• isRemoved: boolean
  True if this message has been removed.
• latitude: number(double)
  The object's latitude.
• longitude: number(double)
  The object's longitude.
• messageURL: string(url)
  Any associated message URL.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• nPages: integer(int32)
  The number of rendered pages.
• objectType: string
  The type of this object.
• pageURLs: array pageURLs
  The document page URLs.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• thumbnailURL: string(url)
  The document thumbnail URL.
• url: string(url)
  A URL to this object.

{
    "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"
        }
    }
}

Nested Schema : pageURLs

Type: array

The document page URLs.

Show Source

• [0]: string(url)
  The document page URLs.

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