Get activity log of a change request

This endpoint is used to retrieve user activities on a change request.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{clientId}/changeRequests/{changeRequestId}/activitylog

Sample URLs

https://{api-url}/api/v2/tenants/client_4/changeRequests/CHG0000001801/activitylog?startTs=2018-10-29T12:26:27 0000&endTs=2018-11-02T12:26:27 0000&isDescendingOrder=true

Parameters

All parameters are optional:

FieldDefault ValueDescription
startTsTicket created timeTo retrieve activities performed on a change request within a certain duration, provide the start time and end time. startTs indicates the from date and time.
Example: 2018-08-10T05:39:51 0000
endTsCurrent timeendTs indicates the to date and time.
Example: 2018-08-25T10:20:15 0000
isDescendingOrdertrueTo list the data in a descending order (high to low), provide isDescendingOrder: true, otherwise provide false. By default, data is listed in descending order.
Example: To arrange data from 30th Oct to 1st Oct, provide isDescendingOrder: true

Sample response

{
 "results": [{
 "activity": "Change Request "#CHG0000001801 Reset VPN Details" updated by James",
 "htmlLog": ["<div class="ActivityLogDetails"><p class="AttributeName" >plannedEnd changed to Fri, 30 Nov 2018, 07:15 AM UTC</p>
  <p> class = "AttributeName" >plannedStart changed to Thu, 01 Nov 2018, 06:15 AM UTC</p>
  <p> class = "AttributeName" >workEnd changed to Wed, 21 Nov 2018, 07:15 AM UTC</p>
  <p> class = "AttributeName" >workStart changed to Wed, 07 Nov 2018, 06:15 AM UTC</p></div>"
 ],
 "createdTime": "2018-11-01T06:15:38+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "changeLog": [{
 "attribute": "plannedEnd",
 "oldValue": "",
 "newValue": "Fri, 30 Nov 2018, 07:15 AM UTC"
 },
 {
 "attribute": "plannedStart",
 "oldValue": "",
 "newValue": "Thu, 01 Nov 2018, 06:15 AM UTC"
 },
 {
 "attribute": "workEnd",
 "oldValue": "",
 "newValue": "Wed, 21 Nov 2018, 07:15 AM UTC"
 },
 {
 "attribute": "workStart",
 "oldValue": "",
 "newValue": "Wed, 07 Nov 2018, 06:15 AM UTC"
 }
 ]
 },
 {
 "activity": "Change Request "#CHG0000001801 Reset VPN Details" updated by James",
 "htmlLog": ["<div class="ActivityLogDetails"><p class="AttributeName" >Assignee changed to global media</p>
  <p> class = "AttributeName" >Change Type changed to Normal</p>
  <p> class = "AttributeName" >Priority changed from Low to High</p></div>"
 ],
 "createdTime": "2018-11-01T06:15:01+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "changeLog": [{
 "attribute": "Assignee",
 "oldValue": "",
 "newValue": "global media"
 },
 {
 "attribute": "Change Type",
 "oldValue": "",
 "newValue": "Normal"
 },
 {
 "attribute": "Priority",
 "oldValue": "Low",
 "newValue": "High"
 }
 ]
 },
 {
 "activity": "Change Request "#CHG0000001801 Reset VPN Details" updated by James.Blake",
 "htmlLog": ["<div class="ActivityLogDetails"><p class="AttributeName" > New response "Unable to login to VPN." added.</p></div>"],
 "createdTime": "2018-11-01T06:14:38+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 }
 },
 {
 "activity": "New Change Request "#CHG0000001801 Reset VPN Details" created by James",
 "createdTime": "2018-11-01T06:14:22+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 }
 }
 ],
 "totalResults": 4,
 "pageSize": 4,
 "nextPage": false,
 "startDate": "2018-10-29T12:26:27+0000",
 "endDate": "2018-11-02T12:26:27+0000",
 "descendingOrder": true
}