Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Gets a list of the objects linked to a given object.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  ObjectId

xs:int

mandatory

Sets the identity of the object to get links for.

â–  ObjectType

 

mandatory

restriction enum (xs:string)

- Document (1)

- WorkflowInstance (2)

- Task (4)

- Case (8)

Sets the type of the object to get links for.

â–  GetExtendedInfo

xs:boolean

 

Set to true to get more information about linked objects in the following properties in response: IndexData, WorkflowInstanceInfo, TaskInfo.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ LinkedObjects

 

nillable

Gets a list of linked objects.

≡ WSLinkedObjectInfo

 

list nillable


â–  LinkedObjectId

xs:int

 

Gets the identity of the linked object.

â–  LinkedObjectType

 

 

restriction enum (xs:string)

- None (0)

- AutomaticDocumentLink (1)

- ManualDocumentLink (2)

- DocumentLink (3)

- WorkflowLink (4)

- TaskLink (8)

- CaseLink (16)

- AllLinks (65535)

Gets the type of the linked object. If linked object type is CaseLink(16) see the IsManualCaseLink property for more details.

â–¡ IndexData

 

nillable

Gets the index data of the linked document/case (see type in LinkedObjectType property).

â–  CategoryNo

xs:int

mandatory

Gets the number of the category.

â–¡ CtgryName

xs:string

nillable

Gets the name of the category.

â–  DocNo

xs:int

 

Gets the document number.

â–¡ IndexDataItems

 

mandatory nillable

Gets index data items of the document.

≡ 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

 

Gets the timestamp when the index data was changed.

â–¡ Title

xs:string

nillable

Gets the title of the document.

â–  VersionNo

xs:int

 

Gets the version number of the document.

â–  CaseDefinitionNo

xs:int

 

Gets the number of the case definition.

â–  CaseNo

xs:int

 

Gets the number of the case.

â–¡ LastChangeTimeISO8601

xs:string

nillable

Gets the timestamp (in ISO 8601 format, UTC) when the index data was changed.

â–¡ TaskInfo

 

nillable

Gets information of the linked task (see type in LinkedObjectType property).

â–¡ AssignedToName

xs:string

nillable

Gets the name of the user the task is assigned to.

â–  AssignedToNumber

xs:int

 

Gets the ID of the user the task is assigned to.

â–¡ Comment

xs:string

nillable

Gets the comment of the task.

â–  CompletedDecision

 

 

restriction enum (xs:string)

- Undefined (0)

- Positive (1)

- Negative (2)

Gets the task completed decision.

â–¡ CreatedBy

xs:string

nillable

Gets the name of the task creator.

â–  DocNo

xs:int

 

Gets the document number of the document this task belongs to.

â–¡ DueDate

xs:dateTime

nillable

Gets the due date of the task.

â–¡ Instructions

xs:string

nillable

Gets the instruction text.

â–  IsAssignedToUser

xs:boolean

 

Gets whether or not the task is assigned to the currently active user.

â–  LastUpdate

xs:dateTime

 

Gets the date of the last update of the task.

â–  Mode

 

 

restriction enum (xs:string)

- Complete (1)

- CompleteDecline (2)

- ApproveReject (3)

- YesNo (4)

Gets the mode of the task.

â–¡ StartDate

xs:dateTime

nillable

Gets the start date of the task.

â–  Status

 

 

restriction enum (xs:string)

- NotStartedStatus (1)

- InProgressStatus (2)

- WaitingStatus (3)

- DeferredStatus (4)

- CompletedStatus (5)

- RevokedStatus (6)

Gets the status of the task.

â–¡ Subject

xs:string

nillable

Gets the subject of the task.

â–  TaskNo

xs:int

 

Gets the ID of the task.

â–  IsCreatedByUser

xs:boolean

 

Gets whether or not the task is created by currently active user.

â–  CaseNo

xs:int

 

Gets the case number of the case this task belongs to.

â–¡ DueDateISO8601

xs:string

nillable

Gets the due date of the task (date in ISO 8601 format, example 2024-01-23).

â–¡ LastUpdateISO8601

xs:string

nillable

Gets the date of the last update of the task (in ISO 8601 format, UTC).

â–¡ StartDateISO8601

xs:string

nillable

Gets the start date of the task (date in ISO 8601 format, example 2024-01-23).

â–¡ WorkflowInstanceInfo

 

nillable

Gets information of the linked workflow instance (see type in LinkedObjectType property).

â–¡ AssignedTo

xs:string

nillable

Gets the user name of the user the instance is currently assigned to.

â–  Claimed

xs:boolean

 

Gets the claimed status of the instance.

â–¡ CurrTaskName

xs:string

nillable

Gets the name of the current workflow task of the instance.

â–  CurrTaskNo

xs:int

 

Gets the number of the current workflow task for the instance.

â–  InitiatorNo

xs:int

 

Gets the user number of the user who started the workflow instance.

â–  InstanceNo

xs:int

 

Gets the unique instance number of the workflow instance.

â–  LinkType

 

 

restriction enum (xs:string)

- Any (0)

- MainDocument (1)

- AdditionalDocument (2)

Gets the type of the link.

â–¡ ProcessDueDate

xs:dateTime

nillable

Gets the date when the current workflow instance should be finished (routing / processing).

â–¡ ProcessName

xs:string

nillable

Gets the name of the workflow process of the instance.

â–  ProcessNo

xs:int

 

Gets the number of the workflow process of the instance.

â–¡ ProcessStartDate

xs:dateTime

nillable

Gets the date when the current workflow instance was started.

â–¡ TaskDueDate

xs:dateTime

nillable

Gets the date when the current task instance should be finished.

â–¡ TaskStartDate

xs:dateTime

nillable

Gets the date when the current task instance was started.

â–  TokenNo

xs:int

 

The unique number for the current workflow token.

â–  VersionNo

xs:int

 

Gets the version number of the workflow process of the instance.

â–¡ ErrorInfo

xs:string

nillable

The error info of the current workflow.

â–¡ ErrorString

xs:string

nillable

The error code of the current workflow.

â–¡ ErrorTimestamp

xs:dateTime

nillable

The error timestamp of the current workflow.

â–¡ ErrorTimestampISO8601

xs:string

nillable

The error timestamp of the current workflow (in ISO 8601 format, UTC).

â–¡ ProcessDueDateISO8601

xs:string

nillable

Gets the date when the current workflow instance should be finished (routing / processing) (date in ISO 8601 format, example 2024-01-23).

â–¡ ProcessStartDateISO8601

xs:string

nillable

Gets the date when the current workflow instance was started (date in ISO 8601 format, example 2024-01-23).

â–¡ TaskDueDateISO8601

xs:string

nillable

Gets the date when the current task instance should be finished (date in ISO 8601 format, example 2024-01-23).

â–¡ TaskStartDateISO8601

xs:string

nillable

Gets the date when the current task instance was started (date in ISO 8601 format, example 2024-01-23).

â–  IsManualCaseLink

xs:boolean

 

Returns True for a manual case link. See also the LinkedObjectType property: CaseLink + False = automatic case link.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.