Change Requests
Request a list of change requests that the current user has the ability to approve or reject. It may contain already approved/rejected items.
Only available to hosted SaaS clients
HTTP Request
GET /icweb.dll/approval/
Responses
Name |
Type |
Description |
200 OK |
changeRequest [] |
When the change requests are requested. |
Change Request
This contains a change request and information associated with what data has been requested to be changed.
Name |
Type |
Description |
Optional |
Default |
|
integer |
Unique Identifier for this change rquest, used to approve/reject the request. |
No |
|
|
string |
Date/Time the change request was submitted. |
Not |
|
|
string |
Name of the object/table that the change request relates to. |
Yes |
|
|
string |
Name of the person that submitted the change request. |
No |
|
|
bool |
Determines if the change request has been approved. If this is false but approvedRejectedBy is not null, then the change has been rejected. |
No |
|
|
String |
Name of the person that approved or rejected the change request, null if the change has not been rejected or approved. |
Yes |
|
|
String |
Comments provided by the person requesting the change. |
No |
|
|
string |
One of three operations, Add, Update, Delete. |
No |
|
|
Contains the data associated with the current state of the row. This will not be available for ‘Add’ operations. |
Yes |
||
|
Contains the data associated with the desired state of the row. This will not be available for ‘Delete’ operations. |
Yes |
Example
Retrieve all the approvals for the current user.
Request
GET /icweb.dll/approval/
Response
- [{
“id”: 1, “requested”: 45960.1359869213, “object”: “Workpack”, “requestedBy”: “Administrator”, “isApproved”: false, “approvedRejectedBy”: “”, “comments”: “Please create this new workpack for me.”, “operation”: “Add”, “newValues”: {
“Workpack_ID”: -2, “Name”: “Test Workpack”, “Actual_Start”: “2025-10-30T00:00:00.000Z”, “Description”: “This is a new workpack”, “ReadOnly”: false, “Task_Time”: “0.0”, “Hours_Per_Day”: 12, “Estimated_Duration”: “0.0”, “Actual_End”: “2025-10-30T00:00:00.000Z”, “Total_Cost”: “0.0”, “Cost”: “0.0”
}
}
]
Approve/Reject Change
Approve or Reject a change request, and if relevant make the applicable changes to the row.
Only available to hosted SaaS clients
HTTP Request
POST /icweb.dll/approval/{Id}/{approve|reject}
- {
“comments”: “Please update change request with correct information”
}
URI Parameters
Name |
In |
Required |
Type |
Description |
|
Path |
Yes |
String |
Specifies the change request |
|
Path |
Yes |
String |
Specifiy whether to approve or reject the change request. In the case of reject a comment may be supplied in the json body of the POST |
|
Body |
Yes |
String |
Specifies a comment when a change request is rejected. |
Responses
Name |
Type |
Description |
200 OK |
Change request was successfully approved/rejected. |
|
404 Unsupported |
String |
Unsupported action for change request, neither approve or reject was specified. |
404 Invalid |
String |
Change request has already been actioned, You can’t approve or reject a change request that has already been approved or rejected. |
404 Not Found |
String |
Unknown change request, the id provided was not found or you don’t have permissions to action it. |