Skip to main content
PATCH
/
activitylogs
/
v2
/
rs
/
{activityLogId}
Update an activity log
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/activitylogs/v2/rs/{activityLogId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "comment": "Comment on the activityLog",
  "type": 1,
  "date": "2024-12-01T12:34:56.000Z",
  "siteIds": [
    1,
    2,
    3
  ]
}
'
{
  "data": {
    "id": 1,
    "comment": "Comment on the activityLog",
    "type": 1,
    "date": "2024-12-01T12:34:56.000Z",
    "createdByUserId": 1,
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "deletedAt": "2024-01-15T08:45:00.000Z",
    "archivedAt": "2024-01-15T08:45:00.000Z",
    "siteIds": [
      1
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

activityLogId
integer
required

Unique identifier of the activityLog.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Body

application/json

Details required to update an activity log

comment
string

Comment on the activityLog.

Example:

"Comment on the activityLog"

type
enum<number>

ActivityLog type.

Available options:
1,
2,
3
Example:

1

date

Date of the activityLog.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

siteIds
integer[]

Unique identifiers of the associated sites.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]

Response

201 - application/json

The activity logs have been updated

data
object
required