The following macros are not currently supported in the header:
  • style

List activity threads

Owned by Kun Liu (Unlicensed)
Last updated: Jan 14, 2016 by Kurt Wagner (Unlicensed)Version comment

Resource URL

UNDER DEVELOPMENT

 Returns a list of activity threads. Each thread response contains the newest activity. For all activities in a thread please use Get activity thread

GET /activities/threads 
ANY /activities/threads?_method=get

Parameters

Table of allowed parameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.

Filtering Activities

You can filter the returned list using the _filters parameter.

NameExampleDescription
date_logged_before_filters=date_logged_before(14000000000)The logged date before this date provided. Accept unix timestamp
date_logged_after_filters=date_logged_after(13000000000)The logged date after this date provided. Accept unix timestamp
staff_involved_filters=staff_involved(1035, 1025)The ids of the staff members who interact in the thread
scope_filters=scope(internal)The scope accept internal or external
against_type AND against_id_filters=against_type(company),against_id(10)Filter threads related to a given object. Note. Unlike other against filters, this one only supports filtering of one object at a time and requires both against type and id to be provided.

Handling the response

Sample Response

GET /activities/threads.json
{
    "meta": {
        "message": "Everything executed as expected.",
        "status": "ok",
        "more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok"
    },
	"response": {
		"threads" : [
			{
				"total_activities": 10,
				"id": 123,
        		"activities": [
            		{
                		"owner": { …. },
                		"subject": "..",
                		...
                		"interactions": {
                    		"staff": [1,2,3],
                    		"affiliations": [4,5,6]
                		}  
            		},
        		]
			}
			...
		],
        "staff": [{ "id": 1, "name": "..." } ...],
        "contacts":[...] 
	}
}