TaskAuditTrail

Tasks Audit Trail APIs

Operation
Retrieve the Audits for Tasks in a Workspace

Operations

Retrieve the Audits for Tasks in a Workspace

Request

GET /tasks/workspace/123/audits HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: Bearer frootymcnooty/vonbootycherooty

Retrieve the Audits in a CSV file

Request

GET /tasks/workspace/123/audits HTTP/1.1
Accept: text/csv
Authorization: Bearer frootymcnooty/vonbootycherooty

Filters

Filters are query string parameters that are used to filter the tasks in your workspace, e.g.

GET /tasks/workspace/123/audits?daysBack=5&pagesize=50&skipitems=0

Parameter	Default value	Additional notes
daysBack	30	Number of days worth of Audits to bring back
pagesize	50	Minimum value: 1; Maximum value: 500.
skipitems	0

Response

If successful, this method will return a response with an OK status code. This response uses the standard error codes and returns standard response headers.

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
  "changes": [
    {
      "title": "The title of the audited Task",
      "createdDate": "Mon, 20 Jan 2020 15:58:12 GMT",
      "type": "TaskCommentCreated",
      "newValue": "Some comment that was added",
      "actors": [
        {
          "name": "Joe Blogs",
          "email": "[email protected]",
          "rel": "Actor",
          "links": [
              { "rel": "self", "href": ".." },
              { "rel": "avatar", "href": "..", "type": "image/jpeg" },
              { "rel": "alternate", "href": "..", "type": "text/html" }
          ]
        }
      ],
      "links": [
        { "rel": "subject", "href": ".." },
        { "rel": "workspace", "href": ".." }
      ]
    },
    ...
  ],
  "links": [
    { "rel": "self", "href": "..." },
    { "rel": "workspace", "href": "..." },
    { "rel": "current", "href": "..." },
    { "rel": "first", "href": "..." },
    { "rel": "prev", "href": "..." },
    { "rel": "next", "href": "..." }
  ]
}

Link relations

Type	Name	Description	Methods
Actors	self	The URI of the User.	GET
Actors	avatar	The URI of the Users Avatar.	GET
Actors	alternate	The URI of the Users Profile.	GET
Changes	subject	The URI of the Task.	GET
Changes	workspace	The URI of the Workspace.	GET
Links	self	The URI of the Audit Trail.	GET
Links	workspace	The URI of the Workspace.	GET
Links	current	The URI of the current page.	GET
Links	first	The URI of the first page.	GET
Links	next	The URI of the next page.	GET
Links	prev	The URI of the previous page.	GET

Error Responses

Case	Response Code	Error Code
User is not a member of the Workspace	403 Forbidden	WorkspaceMembershipRequired
Workspace is locked	403 Forbidden	WorkspaceLocked
Workspace is deleted	404 Not Found	WorkspaceDeleted