Skip to main content

    Web Service Method: Request the History of Concepts

    Abstract

    Web Service Method: Request the History of Concepts

    Description

    Returns history events of a specific concept or a list of concepts.

    Note

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

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

    Request

    Supported Methods

    GET

    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.

    Learn more about the options here: 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.

    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

    Please refer to this page 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).

    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 a RDF literal in a certain language.

    Attribute

    Type

    Comment

    label

    String

    The label String

    language

    String

    Language of the literal

    URL Pattern

    Request Pattern 

    {{url}}/PoolParty/api/history/{{projectId}}/concepts?concepts={{target-concept}}

    Examples

    Example Request - Filtering History of One Concept by One User 

    {{url}}/PoolParty/api/history/{{projectId}}/concepts?concepts=http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3&users=https://preview.poolparty.biz/user/nagyh

    Example Response Snippet 

    [
 {
 "uri": "historyEvent:cc716fb6-8809-483d-b6ab-08133b8fdc88",
 "creatorName": {
 "uri": "https://preview.poolparty.biz/user/nagyh"
 },
 "createdDate": "2016-02-25T15:54:53",
 "subjectOfChange": "http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3",
 "changeType": "ADDITION",
...
 
 {
 "uri": "historyEvent:c55e2a6d-76a4-449f-8f06-396e7ab8cdef",
 "creatorName": {
 "uri": "https://preview.poolparty.biz/user/nagyh"
 },
 "createdDate": "2016-02-25T15:53:39",
 "subjectOfChange": "http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3",
 "changeType": "ADDITION",
 "historyEvent": "http://schema.semantic-web.at/ppt/history#ResourceChangeHistoryEvent"
 }
]

    Example Request - Filtering History of One Concept by Time Frame 

    {{url}}/PoolParty/api/history/{{projectId}}/concepts?concepts=http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3&fromTime=2016-02-26T15:06:47&toTime=2016-03-25T15:06:47

    Example Response Snippet 

     [
 {
 "uri": "historyEvent:cb63773c-a9c7-470b-9edb-48f79dd44c45",
 "creatorName": {
 "uri": "https://preview.poolparty.biz/user/muecksteinm"
 },
 "createdDate": "2016-03-25T15:06:46",
 "subjectOfChange": "http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3",
 "changeType": "ADDITION",
 "historyEvent": "http://schema.semantic-web.at/ppt/history#CustomRelationHistoryEvent",
 
 ...
"createdDate": "2016-03-25T11:34:23",
 "subjectOfChange": "http://internal.semantic-web.at/infra/product/789aa99a-7b8f-4f30-988f-58bb10eb80d3",
 "changeType": "REMOVAL",
 "historyEvent": "http://schema.semantic-web.at/ppt/history#CustomTypeAddRemoveHistoryEvent",
 "predicate": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
 "customType": "https://schema.org/Thing"
 }
]