Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

CreateDocument

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/CreateDocument

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateDocument

Creates and archives new Therefore™ document.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateDocument

Element Name	Element Type	Restrictions	Description
■ parameters
■ CategoryNo	xs:int	mandatory	The number of the category the document belongs to.
□ CheckInComments	xs:string	optional nillable	The Check-in comment.
□ IndexDataItems		optional nillable	Index data items of the document.
≡ WSIndexDataItem		optional unbounded nillable
□ DateIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets date value of the field. Date value should be specified without time zone information (in .net DateTimeKind.Uspecified, xml value like 2002-09-24T00:00:00) or as UTC date time (in .net DateTimeKind.Utc, xml value like 2002-09-24T00:00:00Z). This is mandatory, especially when client and server are located in different time zones. See also the DataISO8601Value property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets date value of the field in ISO 8601 format (YYYY-MM-DD, example 2017-07-23). See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ IntIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:int	mandatory nillable	Gets or sets the integer value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ LogicalIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:boolean	mandatory nillable	Gets or sets Boolean value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ MoneyIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:double	optional nillable	Gets or sets the DOUBLE value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty. DEPRECATED: Use the DecimalDataValue property instead for Therefore™ version 2018 and newer.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ DecimalDataValue	xs:decimal	optional nillable	Gets or sets the DECIMAL value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty.
□ MultipleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue		mandatory nillable	Gets or sets multiple keyword values of the field.
≡ Keyword	xs:string	optional unbounded nillable
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ KeywordNos		optional nillable	Gets or sets multiple keyword numbers of the field.
≡ KeywordNo	xs:int	optional unbounded
□ SingleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets a single keyword value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the field name (when you set it use column name + "_Text" suffix. example: for SK field "Department" use "Department_Text" for it's TEXT value) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ StringIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets the string value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ TableIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue		mandatory nillable	Gets or sets the table value of the field.
≡ WSTableFieldDataRow		optional unbounded nillable
□ DataRowItems		optional nillable	Gets or sets the items of the row. If it is set to null for update operation - record with given row number (see RowNo parameter) will be deleted.
≡ WSTableFieldDataRowItem		optional unbounded nillable
□ DateIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets date value of the field. Date value should be specified without time zone information (in .net DateTimeKind.Uspecified, xml value like 2002-09-24T00:00:00) or as UTC date time (in .net DateTimeKind.Utc, xml value like 2002-09-24T00:00:00Z). This is mandatory, especially when client and server are located in different time zones. See also the DataISO8601Value property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets date value of the field in ISO 8601 format (YYYY-MM-DD, example 2017-07-23). See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ IntIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:int	mandatory nillable	Gets or sets the integer value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ LogicalIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:boolean	mandatory nillable	Gets or sets Boolean value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ MoneyIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:double	optional nillable	Gets or sets the DOUBLE value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty. DEPRECATED: Use the DecimalDataValue property instead for Therefore™ version 2018 and newer.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ DecimalDataValue	xs:decimal	optional nillable	Gets or sets the DECIMAL value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty.
□ SingleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets a single keyword value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the field name (when you set it use column name + "_Text" suffix. example: for SK field "Department" use "Department_Text" for it's TEXT value) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ StringIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets the string value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ AccessMask		optional nillable	Gets access mask for index data field (column) for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets UTC date time value of the field. Date value should be specified as UTC date time. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets UTC date time value of the field in ISO 8601 format (example 2018-05-03T14:45:00Z). Date value should be specified as UTC date time. See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ RowNo	xs:int	optional nillable	Gets or sets the number of the row. While updating the data - null value means creating new row. Starts at 0 (zero).
□ AccessIsEditableRow	xs:boolean	optional nillable	Gets access status for the row for connected user.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ AccessMask		optional nillable	Gets access mask for index data field for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets UTC date time value of the field. Date value should be specified as UTC date time. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets UTC date time value of the field in ISO 8601 format (example 2018-05-03T14:45:00Z). Date value should be specified as UTC date time. See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ Streams		optional nillable	Represents list of files to store within the document.
≡ WSStreamInfoWithData		optional unbounded nillable
□ FileData	xs:base64Binary	mandatory nillable	Gets or sets binary data of the file. It uses base64 encoding.
□ FileName	xs:string	mandatory nillable	Gets or sets the name of the stream file.
□ StreamNo	xs:int	optional nillable	Gets or sets the number of the stream.
□ DoFillDependentFields	xs:boolean	optional nillable	Set to true or false to explicitly execute or skip FillDependentFields step while writing index data. If not set or null the old behavior will be used. That means the FillDependentFields step will be executed. Note: In order to update primary and dependent fields you can: 1. specify both values (for primary and dependent) or just for primary. In this case primary field will be used to lookup related value(s) for dependent field(s). Value of dependent field(s) from the request will be ignored. 2. specify value of dependent field(s) only. In this case if a unique primary field (related to given dependent field(s)) can be found it will be used. Otherwise, if there are many values found for primary field an error will be returned.
□ WithAutoAppendMode		optional nillable restriction enum (xs:string) - DefaultMode (0) - Begin (1) - End (2) - Replace (3) - Disabled (4)	Sets auto append mode for the document. Null or omitted value means that auto append mode is Disabled. With Enabled auto append mode use IndexDataItems to specify unique identifier of the document.
□ ConversionOptions		optional nillable	Specifies options to convert the files.
■ AnnotationMode		optional restriction enum (xs:string) - Default (0) - Merge (1) - Hide (2)	Sets the annotation mode.
□ CertificateName	xs:string	optional nillable	Sets the name of the certificate for signing the file.
■ ConvertTo		optional restriction enum (xs:string) - Original (0) - SingleTIFF (1) - SinglePDF (2) - MultipageTIFF (3) - MultipagePDF (4) - SearchablePDF (5) - SearchablePDFA (6) - Jpeg (50)	Sets the conversion file format. Notes for multipage conversion types: - In the CreateDocument, AddStreamToDocument, and SubmitCreateDocumentBatch methods, the conversion type will be applied to all the specified streams together. - In the UpdateDocument and SubmitUpdateDocumentBatch methods, the conversion type will be applied to all the new streams together. But for updated streams this will be done on a one by one basis.
■ SignatureMode		optional restriction enum (xs:string) - NoSignature (0) - SignatureOnly (1) - SignatureAndTimestamp (2)	Sets the signature mode.
□ TimeStampPwd	xs:string	optional nillable	Sets the password for the user for the timestamp server.
□ TimeStampServer	xs:string	optional nillable	Sets the name of the timestamp server for signing the file.
□ TimeStampUser	xs:string	optional nillable	Sets the user for the timestamp server.
□ MultipageStreamName	xs:string	optional nillable	Sets the name of the multipage result stream. Specifies a stream name to be used instead of default one (given by conversion server). Use it with multipage conversion types (see the ConvertTo parameter). Value will be ignored for a single page TIFF/PDF, JPEG, and Original conversion types.
■ LastChangeTime	xs:dateTime	optional	Is a timestamp that displays when the index data was changed. Must be set to avoid conflicting changes and data lost. Used for auto-append.
■ DontResetCategoryDefaults	xs:boolean	optional	Set to true or false to explicitly execute or skip ResetCategoryDefaults step before writing index data.
□ FileUploadSessions		optional nillable	Represents list of file upload sessions to be used to store files within the document. See the UploadSessionStart and UploadSessionAppendChunk methods for more details.
≡ WSStreamInfoUploadSessionData		optional unbounded nillable
□ FileName	xs:string	mandatory nillable	Gets or sets the name of the stream file.
□ StreamNo	xs:int	optional nillable	Gets or sets the number of the stream.
■ UploadSessionId	xs:string	mandatory GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets or sets id of the upload session for content of the given file.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateDocumentResponse

Element Name	Element Type	Restrictions	Description
■ parameters
■ DocNo	xs:int	optional	The document number of the new document.
■ LastChangeTime	xs:dateTime	optional	The timestamp when the index data was changed.
■ VersionNo	xs:int	optional	The version number of the document.

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.