Method DeleteDocuments
DeleteDocuments(String, List<String>, Boolean, Boolean)
Delete documents
Declaration
List<string> DeleteDocuments(string connectionId, List<string> documentIds, bool ignoreRecycleBin, bool doNotDeletePhysicalFiles)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
System.Collections.Generic.List<System.String> | documentIds | List of document ids to delete. See also Id |
System.Boolean | ignoreRecycleBin | If true the recycle bin settings are ignored |
System.Boolean | doNotDeletePhysicalFiles | If true physical files are not deleted |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.String> | Returns the list of deleted document ids |
Examples
POST http://YourServerName/InfoShare/Json/Document/DeleteDocuments
Example for delete documents.{
"connectionId": "1fbe116a-20a9-4378-b198-6cf3283f0238",
"documentIds": ["7f319f71-74db-e911-a946-00155d290a08", "ad24ab77-74db-e911-a946-00155d290a08"],
"doNotDeletePhysicalFiles": false,
"ignoreRecycleBin": false
}
Response:
{
"DeleteDocumentsResult": ["7f319f71-74db-e911-a946-00155d290a08", "ad24ab77-74db-e911-a946-00155d290a08"]
}
Exceptions
Type | Condition |
---|---|
ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
ServiceException | No document found for documentId {documentId} (10005) |
ServiceException | Not allowed (10014) |
ServiceException | Verification code is needed: Verification code not yet verified (10152) |