Skip to main content
POST
/
activities
Get Resource Activities Between Dates
curl --request POST \
  --url https://apigw.bienport.com/api/activities \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '
{
  "resourceIds": [
    1058,
    1059
  ],
  "page": 123,
  "pageSize": 10,
  "startTime": 1634714715919,
  "endTime": 1634800575919,
  "startSec": 15475,
  "finishSec": 86400,
  "types": 0,
  "groupIds": "All IDs can be seen from the list method of the Event Groups Api. (Null or empty array returns activities of all groups.)"
}
'
{
  "totalRecords": 123,
  "page": 123,
  "pageSize": 123,
  "activities": [
    {
      "eventId": "event617102d616b8be31ebfadfdd",
      "activityTime": 1634713761000,
      "description": "Periodical Test Signal",
      "eventType": "Event / Violation / Error",
      "violationName": "Communication Error",
      "violationType": "Alarm (Red) / Error (Gray) / Warning (Yellow)",
      "msgType": 123,
      "vioType": 123,
      "group": 123
    }
  ]
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

activitiesRequest

GetActivities Request Api Model

resourceIds
integer<int64>[]

Enter the alarm panel IDs whose activity you want to bring.

Example:
[1058, 1059]
page
integer<int32>

The page number you want to view.

pageSize
integer<int32>

The number of records to display on a page.

Example:

10

startTime
integer<int64>

Initial value of date constraint.

Example:

1634714715919

endTime
integer<int64>

End value of date constraint.

Example:

1634800575919

startSec
integer<int32>

The start time of the constraint in seconds.

Example:

15475

finishSec
integer<int32>

The end time of the constraint in seconds.

Example:

86400

types
integer<int32>[]

The type of activity to be listed.

Example:

0

groupIds
integer<int32>[]

The ID of the activity groups to be listed.

Example:

"All IDs can be seen from the list method of the Event Groups Api. (Null or empty array returns activities of all groups.)"

Response

List of Activities

Get Activities Response Api Model

totalRecords
integer<int64>

Total number of activities.

page
integer<int32>

The page number you want to view.

pageSize
integer<int32>

The number of records to display on a page.

activities
ActivityResponse · object[]

List of activities.