Skip to content

activityHistory

No recent usage observed

No replacement exists in the new API yet. However, no calls to this endpoint were recorded in production access logs (April to June 2026), so it may be retired early, without a replacement. If your integration uses this endpoint, contact Oneserve support as soon as possible so that it stays supported.

Reference

/rest/workflow/activity/history/{startDate}/{endDate}/{clientGroupId}/{clientIdList}/{eventId}

GET
Gets activity history for the period specified (start date/time to end date/time inclusive) and for the client ID specified.

Parameters

startDate - date to get activity history from in format dd-mmm-yyyy hh:mm:ss
endDate - date to get activity history to in format dd-mmm-yyyy hh:mm:ss
clientGroupId - the ID of the ClientGroup
clientIDList - a comma-seperated list containing the ID's of the clients to include - if this parameter is not supplied activity for all clients for the Client Group will be returned
eventId - event type - restricts activity history returned to only jobs where the specified event has occurred

Note: maximum difference between end and start date is one month

e.g. rest/activity/history/29-May-2012%2010:30:00/30-May-2012%2000:00:00/1/71,135,326

available response representations:
  • 200 - XML
<root>
  <actEvent>
    <dateTime>12/12/2012 10:12:34</dateTime>
    <clientId>3</clientId>
    <jobRef>J000KL</jobRef>
    <jobClientRef>ABC123</jobClientRef>
    <activityId>342342</activityId>
    <activityCode>BB-HH34</activityCode>
    <totalQty>43.00</totalQty>
    <updateQty>4.00</updateQty>
    <action>2</action>
    <qtyAction>A</qtyAction>
  </actEvent>
</root>


Field Notes

dateTime - date/time of activity history record
clientId - client Id
jobRef - Oneserve unique job ref
jobClientRef - Oneserve job client Ref
activityId - unique activity record Id
activityCode - library activity code
totalQty - qty on activity history record
updateQty - qty change from previous value
action - action from activity history record: 1 = Add, 2 = Update, 3 = Delete
qtyAction - action that occurred to quantity: A - qty added, D - qty deleted, U - qty not changed


See the Workflow API matrix for the full list of endpoints in this category.