Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can filter the returned list using the _filters parameter.

NameExampleDescription
owner_type  
type  
invitation  
readread(no) or read(0) or read(n) 
parent_id  
thread_id  
staff_id  
priority_id  
class_id  
task_id  
message_id  
owner_id  
visibility  
medium  
against_typeagainst_type(company,job)Only return activities against the given type
against_idagainst_id(12,12)Only return activities against object with given ids.
order_by_ascorder_by_asc(date_ended)

date_started, date_created, date_ended, date_logged and id

billable, nonbillable

order_by_desc Same as order_by_asc but opposite direction
date_created_before  
date_created_after  
date_started_before  
date_started_after  
date_logged_before  
date_logged_after  
date_ended_before  
date_ended_after  
max_id  
min_id  

<field_name>_greater_than(<value>),

<field_name>_less_than(<value>),

<field_name>_greater_than_or_equal(<value>),

<field_name>_less_than_or_equal(<value>)

 

_filters=id_greater_than(5)

Available fields:

id
thread
against_id
owner
staff
priority
class
task

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

Handling the response

Sample Response

...

Code Block
languagejavascript
{
    "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":[...] 
	}
}