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

SubmitCreateDocumentBatch

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

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

Submits an operation to create and archive a new Therefore™ document.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ BatchId	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}	Batch id of a current operation.
■ CategoryNo	xs:int	mandatory	Gets or sets the number of the category a new Document belongs to.
□ CheckInComments	xs:string	nillable	The Check-in comments.
□ IndexDataItems		mandatory nillable	Gets or sets index fields data values.
≡ WSIndexDataItem		list nillable
□ DateIndexData		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	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	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	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		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	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		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	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		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	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	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	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		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	list nillable
□ FieldName	xs:string	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		nillable	Gets or sets multiple keyword numbers of the field.
≡ KeywordNo	xs:int	list
□ SingleKeywordData		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	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		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	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		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		list nillable
□ DataRowItems		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		list nillable
□ DateIndexData		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	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	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	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		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	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		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	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		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	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	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	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		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	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		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	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		nillable	Gets access mask for index data field (column) for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		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	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	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	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.
□ RoleAccessMask		nillable	Gets the role access mask for index data field(column) for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
□ RowNo	xs:int	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	nillable	Gets access status for the row for connected user.
□ FieldName	xs:string	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		nillable	Gets access mask for index data field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		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	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	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	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.
□ RoleAccessMask		nillable	Gets the role access mask for index data field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
□ DoFillDependentFields	xs:boolean	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.
□ ConversionOptions		nillable	Specifies options to convert the files.
■ AnnotationMode		restriction enum (xs:string) - Default (0) - Merge (1) - Hide (2)	Sets the annotation mode.
□ CertificateName	xs:string	nillable	Sets the name of the certificate for signing the file.
■ ConvertTo		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		restriction enum (xs:string) - NoSignature (0) - SignatureOnly (1) - SignatureAndTimestamp (2)	Sets the signature mode.
□ TimeStampPwd	xs:string	nillable	Sets the password for the user for the timestamp server.
□ TimeStampServer	xs:string	nillable	Sets the name of the timestamp server for signing the file.
□ TimeStampUser	xs:string	nillable	Sets the user for the timestamp server.
□ MultipageStreamName	xs:string	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. For the GetConvertedDocStreams, GetConvertedDocStreamsRaw methods set desired file name without extension or null for default name (default is document title).
■ DontResetCategoryDefaults	xs:boolean		Set to true or false to explicitly execute or skip ResetCategoryDefaults step before writing index data.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ DocNo	xs:int		The document number of the new document.
■ LastChangeTime	xs:dateTime		The timestamp when the index data was changed.
■ VersionNo	xs:int		Gets the version number of the document.
□ LastChangeTimeISO8601	xs:string	nillable	Gets the timestamp (in ISO 8601 format, UTC) when the index data was changed.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.