Web Service Method: Delete Project History Filtered by Concepts

Description

Deletes history events of a specific project filtered by concepts. Parameters can be used to limit the events that should be removed.

Note

History events of a project are triggered when concepts are edited. Find a detailed description here:PoolParty History

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

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

concepts

The concept or list of concepts for which history information should be retrieved.

Please refer to this topic when you want to learn more about the options Using a list of request parameters

Array of Strings

true

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.

Please refer to this topic when you want to learn more about the options 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

Please refer to this topic when you want to learn more about the options 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

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

Response

JSON Response - Successful

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

Examples

Example Request - Remove History Events for a Specific Concept

 POST {{url}}/PoolParty/api/history/{{projectId}}/deleteByConcepts?concepts=https://preview.poolparty.biz/Newproject/M-y-Scheme/1