Web Service Method: Request the History of a Project

Abstract

Description
Returns history events of a specific project.

Note

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

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

Request

Supported Methods
GET

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, addLodLink, removeLodLink, addProjectLinking, removeProjectLinking`	Array of Strings	false
limit	Maximum number of returned events The default value is 100. To disable the limit, set the value to -1.	Integer	false
offset	Number of events that should be skipped. The events are ordered from the oldest to the latest. The default value is 0.	Integer	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).

Response

Array of history events.

Attribute	Type	Comment
`uri`	String	URI of the history event
`creatorName`	String	Editor who is responsible for history event
`createdDate`	String	Date when history event was created
`subjectOfChange`	String	URL of the concept that was changed
`changeType`	String	Type of change like: REMOVAL, ADDITION
`collectionRelation`	JsonRelation
`customType`	String
`historyEvent`	String
`member`	JsonRelation
`newUri`	String
`newValue`	LanguageLiteral
`noteTitle`	String
`oldUri`	String
`oldValue`	LanguageLiteral
`predicate`	String
`relationTarget`	JsonRelation
`workflowStatus`	String

JSON Relation

Attribute	Type	Comment
`label`	String	Label of the related resource
`uri`	String	URI to the related resource

Language Literal

Object representing an RDF literal in a certain language.

Attribute	Type	Comment
`label`	String	The label String
`language`	String	Language of the literal

Example

Example Request

https://<server-url>/PoolParty/api/history/1DDFD355-4EBC-0001-40B5-1D6C15121111?fromTime=25.07.2016T17:29:20&toTime=25.07.2016T17:29:26

Example Response

[
  {
    "uri": "historyEvent:7c24cf17-54c3-4378-87ca-16b1ceae1f70",
    "creatorName": {
      "uri": "https://preview.poolparty.biz/user/huberf"
    },
    "createdDate": "2016-07-25T10:05",
    "subjectOfChange": "https://preview.poolparty.biz/HistoryTimetest/0",
    "changeType": "ADDITION",
    "historyEvent": "http://schema.semantic-web.at/ppt/history#RelationAddRemoveHistoryEvent"
  },
  {
    "uri": "historyEvent:4fbd3db5-e466-4adb-946a-f409081b8464",
    "creatorName": {
      "uri": "https://preview.poolparty.biz/user/huberf"
    },
    "createdDate": "2016-07-25T10:04",
    "subjectOfChange": "https://preview.poolparty.biz/HistoryTimetest/0",
    "changeType": "ADDITION",
    "historyEvent": "http://schema.semantic-web.at/ppt/history#ResourceChangeHistoryEvent"
  }
]

In this section: