Web Service Method: Delete Documents from a Corpus

Abstract

Description
Deletes documents from the corpus.

URL: /PoolParty/api/corpusmanagement/{project}/documents/delete

Request

Supported Methods
POST

Content-Type

application/x-www-form-urlencoded

Path Variables

Variable	Comment
`{project}`	The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter	Comment	Type	Required
corpusId	ID of the target corpus. Note Please note that the provided value should start with "corpus:". The ID alone is not sufficient. An example for corpusId value could be `corpus:a7b55be0-17c6-44b6-807c-064c6734f03e`	String	true
documentIds	ID of documents that should be deleted.	List of strings	true

Parameter

Comment

Type

Required

corpusId

ID of the target corpus.

Note

Please note that the provided value should start with "corpus:". The ID alone is not sufficient.

An example for corpusId value could be corpus:a7b55be0-17c6-44b6-807c-064c6734f03e

String

true

documentIds

ID of documents that should be deleted.

List of strings

true

Response

http status code 200if OK + JSON formatted success message.

Example

POST Request

http://<server-URL>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/documents/delete?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2&documentIds=corpusDocument:9a494f23-aafd-4c47-839d-81ba0694370c, corpusDocument:4dd0c210-fcd4-443b-ae66-bbc7f9446798

JSON Formatted Response

{
    "success": true,
    "message": "Deleting documents from corpus was successful."
}

In this section: