Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Updates an existing Thereforeâ„¢ document.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ CheckInComments

xs:string

nillable

The Check-in comment.

â–  DocNo

xs:int

mandatory

Number of the document that will be updated.

â–¡ IndexData

 

nillable

Index data items to update/add/delete a document.

â–¡ IndexDataItems

 

mandatory nillable

Sets the index data field's 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.

â–  LastChangeTime

xs:dateTime

 

Is a timestamp that displays when the index data was changed. Is used to avoid conflicting changes and data lost. Should be taken from previous the operation on this document (for example GetCase/GetDocument operation). LastChangeTimeISO8601 parameter can be used instead of LastChangeTime parameter . If LastChangeTime is set the value in LastChangeTimeISO8601 is ignored.

â–¡ 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.

â–¡ LastChangeTimeISO8601

xs:string

nillable

Sets the timestamp (in ISO 8601 format, UTC) when the index data was changed. LastChangeTimeISO8601 parameter can be used instead of LastChangeTime parameter . If LastChangeTime is set the value in LastChangeTimeISO8601 is ignored.

â–¡ StreamNosToDelete

 

nillable

The streams to delete out of the document.

≡ StreamNo

xs:int

list


â–¡ StreamsToUpdate

 

nillable

The streams to update/add a document.

≡ WSStreamInfoWithData

 

list nillable


â–¡ FileData

xs:base64Binary

nillable

Gets or sets binary data of the file. It uses a base64 encoded string in XML messages and a byte array in JSON messages. If both FileData and FileDataBase64JSON are set the value in FileDataBase64JSON gets ignored.

â–¡ FileName

xs:string

mandatory nillable

Gets or sets the name of the stream file.

â–¡ StreamNo

xs:int

nillable

Gets or sets the number of the stream. Note: For document conversion result it always returns null (method GetConvertedDocStreams).

â–¡ FileDataBase64JSON

xs:string

nillable

Gets or sets binary data of the file as a base64 encoded string (for both XML and JSON encoded messages). If both FileData and FileDataBase64JSON are set the value in FileDataBase64JSON gets ignored.

â–  NewStreamInsertMode

 

 

restriction enum (xs:string)

- Append (0)

- Prepend (1)

Sets insert mode for a new file stream when updating the document. Default is 'Append' (append to the end).

â–¡ 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).

â–¡ FileUploadSessions

 

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

 

list nillable


â–¡ FileName

xs:string

mandatory nillable

Gets or sets the name of the stream file.

â–¡ StreamNo

xs:int

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.

â–  NewStreamInsertMode

 

 

restriction enum (xs:string)

- Append (0)

- Prepend (1)

Sets insert mode for a new file stream when updating the document. Default is 'Append' (append to the end).

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  CurrentDocVersion

xs:int

 

Returns the current version of the document.

â–  LastChangeTime

xs:dateTime

 

Returns the timestamp when the index data of the document was changed.

â–¡ 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.

 

 

© 2024 Therefore Corporation, all rights reserved.