Web Service Method: Delete History from Project

Description

Removes history events from a project. Parameters can be used to limit the events that should be removed.

Note

History events of a projects are triggered when concepts are edited. See detailed description here:PoolParty History

URL: /PoolParty/api/history/{project}/delete

Request

Supported Methods

POST

Content-Type

application/x-www-form-urlencoded

Path Variables

Variable

Comment

{project}

The UUID of the project to be used

HTTP Parameters

Parameter

Comment

Type

Required

fromTime

Start point of the requested time frame *

String

false

toTime

End point of the requested time frame *

String

false

label

Filter by a label

String

false

users

Filter by URI of the user/users.

Learn more about the options here:Using a list of request parameters

Array of Strings

false

events

Filter by event type/event types

Possible values: resourceChangeAddition, resourceChangeRemoval, resourceChangeUpdate, addRelation, removeRelation, addLiteral, removeLiteral, updateLiteral, addCollectionMember, removeCollectionMember, createCollection, deleteCollection, importConcept, resourceChangeAddition, addCustomAttributeLiteral, removeCustomAttributeLiteral, updateCustomAttributeLiteral, addCustomRelation, removeCustomRelation, addCustomClass, removeCustomClass

Learn more about the options here:Using a list of request parameters

Array of Strings

false

Note

*) ISO-8601 standard dateTime format (yyyy-MM-dd'T'HH:mm:ss) is supported e.g. 2016-03-25T15:06:47. In addition you can use format dd.MM.yyyy (e.g. 25.07.2016) or for higher granularity you can also choose dd.MM.yyyy'T'HH.mm.ss (e.g. 25.07.2016T17:29:20).

URL Pattern

Request Pattern

 POST http://{{server-url}}/PoolParty/api/history/{{projectId}}/delete

Examples

Example Request - Remove History Events in a Specific Time Frame

 POST {{url}}/PoolParty/api/history/{{projectId}}/delete?fromTime=03.04.2017T17:30:00&toTime=03.04.2017T17:39:59

Example JSON Response - Successful

{
  "success": true,
  "message": "Successfully deleted history."
}