get uri history
/groups/{group}/uris/{uri}/history [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.7900 | 5.9907 | xml, json, csv |
Description
Load the history of events for a specified URI (most recent first).
Supported event types are:
- upload
- creation
- move
- modification
- revert
- structure
- comment
- task
- version
- workflow
- edit
- draft
- note
- xref
- image.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
events | A comma-separated list of types of events to return (all if not specified) | no | strings | |
page | The page to load | no | long | 1 |
pagesize | The number of results per page | no | long | 100 |
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> </event> <event id="" datetime="" type="[upload|creation|move|modification|revert]" [labels=""] [version=""]> <author ...> ... </author> <change type="path|docid|title|labels|description|path|hosturl" from="" to=""/> ... </event> <event id="" datetime="" type="comment" title="[comment title]" fragment="" [labels=""]> <author ...> ... </author> </event> <event id="" datetime="" type="workflow" [labels=""]> <author ...> ... </author> <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> <change type="version" from="" to=""/> </event> <event id="" datetime="" type="task" title="[task title]" fragment="" [labels=""]> <author ...> ... </author> <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> </event> <event id="" datetime="" type="note" fragment="" [labels=""]> <author ...> ... </author> </event> <event id="" datetime="" type="[xref|image]" title="[target title]" fragment="" uriid="" [targetfragment=""] [labels=""]> <author ...> ... </author> </event> </history>
Error Handling
No specific errors expected for this service.