get uris history
/groups/{group}/uris/history [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9600 | 5.9907 | xml, json, csv |
Description
Load the history of events for multiple URIs.
Supported event types are:
- upload
- creation
- move
- modification
- revert
- structure
- comment
- task
- version
- workflow
- edit
- draft
- note
- xref
- image
Does not include events from documents shared to this group unless their folder is specified.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| author | The member ID or username of event author | no | string | |
| documenttype | The URI’s document type | no | string | |
| events | Comma-separated list of event types | yes | string | |
| folder | The URI’s ancestor folder | no | string | |
| from | A start date | no | datetime | current date - 7 days |
| label | An event’s label | no | string | |
| page | The page to load | no | integer | 1 |
| pagesize | The number of results per page | no | integer | 100 |
| publicationid | The ID of the publication to restrict events to | no | string | |
| to | An end date | no | datetime | current date |
Permission
This service is restricted to guest and higher unless the group is accessible to public.
Response
The output has the following format:
<history events="upload,creation,move,modification,structure,
workflow,version,edit,draft,
note,xref,image,comment,task"
[limitreached="true"]>
<event id=""
datetime=""
type="structure"
title="Fragment Move">
<author ...> ... </author>
<uri ...> ... </uri>
</event>
<event id=""
datetime=""
type="[upload|creation|move|modification|revert]"
[labels=""]
[version=""]>
<author ...> ... </author>
<uri ...> ... </uri>
<change type="path|docid|title|labels|description|path|hosturl"
from=""
to=""/>
...
</event>
<event id=""
datetime=""
type="comment"
title="[comment title]"
fragment=""
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
</event>
<event id=""
datetime=""
type="workflow"
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
<change type="status|priority|due|assignedto"
from=""
to="">
[<from>
<assignedto ...> ... </assignedto>
</from>]
[<to>
<assignedto ...> ... </assignedto>
</to>]
</change>
</event>
<event id=""
datetime=""
type="version"
title="[version]"
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
<change type="version"
from=""
to=""/>
</event>
<event id=""
datetime=""
type="task"
title="[task title]"
fragment=""
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
<change type="status|priority|due|assignedto"
from=""
to="">
[<from>
<assignedto ...> ... </assignedto>
</from>]
[<to>
<assignedto ...> ... </assignedto>
</to>]
</change>
</event>
<event id=""
datetime=""
type="[edit|draft]"
fragment=""
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
</event>
<event id=""
datetime=""
type="note"
fragment=""
title="[note title]"
[labels=""]>
<author ...> ... </author>
</event>
<event id=""
datetime=""
type="[xref|image]"
title="[target title]"
fragment=""
uriid=""
[targetfragment=""]
[labels=""]>
<author ...> ... </author>
<uri ...> ... </uri>
</event>
</history>
Error Handling
| 0x100E | When the author parameter is invalid |
|---|