Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Erases specified objects from the system.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ContainerObjectNo

xs:int

nillable

The ID of containing object. If objectType is DocumentObject this refers to the category number. If objectType is CaseObject this refers to the case definition number. 0 or empty means all categories or case definitions.

â–¡ DeleteFromMedia

xs:boolean

nillable

If True document/case files will be deleted from storage media. If False document/case files will remain on the storage media. Default value is False. Empty value means False.

â–¡ ObjectType

 

nillable

restriction enum (xs:string)

- Unknown (-1)

- Server (1)

- Document (2)

- Category (3)

- Field (4)

- DataType (5)

- MediaPool (6)

- Media (7)

- IndexingProfile (8)

- SpoolType (9)

- Query (10)

- User (11)

- Group (12)

- CaptureProfile (13)

- PreProcessor (14)

- COLDForm (15)

- QueryTemplate (16)

- Folder (17)

- LoaderProfile (18)

- WorkflowProcess (19)

- WorkflowTask (20)

- WorkflowInstance (21)

- KeyDict (22)

- StoragePolicy (23)

- Device (24)

- StorageArea (25)

- RetentionPolicy (26)

- Count (27)

- UniversalConnectorProfile (29)

- CaseDefinition (37)

- Case (38)

- Stamp (40)

- ReportDefinition (41)

- eForm (47)

- eFormSubmission (48)

- FormImage (99)

- Keyword (100)

- Migrate (101)

- Connectors (900)

- StorageCtgry (901)

- ServerMediaPools (902)

- StorageAreaMedia (903)

- ServerDevices (904)

- ServerMedia (905)

- TheSystem (1000)

- COLD (1001)

- ExchangeConnector (1002)

- LotusConnector (1003)

- SAPConnector (1004)

The object type to delete. Valid values are Document, Case or null/not set for Both.

â–¡ DeletedByUserNo

xs:int

nillable

Sets the user number of the user that is used for searching deleted objects.

â–¡ DeletedOnFrom

xs:dateTime

nillable

Sets the date specifying the start condition for the deletion date.

â–¡ DeletedOnTo

xs:dateTime

nillable

Sets the date specifying the end condition for the deletion date.

â–¡ ObjectNos

 

nillable

A list of ids/numbers of object to be deleted. If valuse is empty or null all found objects will be deleted.

≡ ObjectNo

xs:int

list


 

 

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

 

<Empty message>

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.