Jump to: navigation, search

AddDocument

Purpose

This method is intended to add a document to an Interaction. This method can be used in 2 modes:

  • Link creation mode—UCS only creates an Attachment record to associate an existing Interaction(defined by the InteractionId parameter)to an existing Document(defined by the DocumentId parameter).
  • Document creation mode—UCS creates an Attachment record and a Document record and associates them to an existing Interaction (defined by the InteractionId parameter) .

The Document record is created using the parameters MimeType, TheName, Description, TheSize, Content. UCS returns the DocumentId in response.

UCS automatically works in "Link creation mode" when a parameter "DocumentId" is present in the request.

URL

  • POST /OMInteractions/AddDocument/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
InteractionId String Max. length: 16 characters true true
DocumentId String Max. length: 16 characters

Mandatory in link creation mode

false true
MimeType String Max. length: 256 characters

Mandatory in link creation mode

false true
TheName String Max. length: 256 characters

Mandatory in document creation mode

false true
Description String Max. length: 256 characters false true
TheSize Integer Optional, if not populated it will be calculated from content size false true
Content Binary false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
DocumentId String Mandatory in document creation mode false true

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.