Returns one or more activity records - used to build an activity kanban board
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | activities.json | |
| General | Yes | Parameters described in API syntax section | Structure of an API call | |
| Model Structure | Yes | Name of model required | modelstructure=kanbanlist | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/activities.json?company=1&version=4&user=user&password=user&modelstructure=kanbanlist
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 219,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"activityuuid": "F94FF187588D104BBC8A5B96A65365C4",
"activityTimeStampModified": 1588148872,
"activityRecordVersionNumber": 163,
"activityAttachmentCount": "6",
"activityCreated": "Created by SYN_Jon on 27/01/2015 at 9:56am",
"activityDetails1stLine": yyy",
"activityRegardingDescription": "Correct testing financial",
"activityRegardingDescription2": "Correct testing financial",
"activityRegardingWhat": "Phase: 1/00000673.002",
"activityPriorityDescription": "Med",
"activityOwnerID": 680,
"activityOwnerName": "Andy Doro",
"activityClientCode": "1/ABAP01",
"activityClientName": "A B Applications Ltd",
"activityCompleted": true,
"activityViewDate": "2015-01-27",
"activityViewTime": "08:00:00",
"activityViewTimezone": "UTCA",
"activityJobNumber": "1/00000673",
"activityJobNumberSimple": "673",
"activityJobAndPhase": "1/00000673.002",
"activityJobAndPhaseSimple": "673.002",
"activitySubject": "mike test phase",
"activityActivitytype": "Req - in owner & watche",
"activityID": 5964,
"activityCreationDate": "2015-01-27",
"activityStageCode": "",
"activityStageDescription": "",
"activityReqisitionCompleted": true,
"activityKanbanStatusCode": "COMP",
"activityKanbanStatusDescription": "Done",
"activityRequisitionChargeCode": "1/AA",
"activityRequisitionResourceCode": "1/AG1",
"activityRequisitionHours": 100
},