URL: v3/api/log-category-list Method: GET Description : Gets the list of log categories Parameters: Parameter Type Optional/Required Description search_query string Optional String that has to be searched limit string Optional Count of results that are required Response: { “success”:true, “data”:{ “log_categories”: [{ “id”:1, “name”:”ticket-create” }, { “id”:2, “name”:”user-create” }, { “id”:3, “name”:”mail-fetch” }, { “id”:4, […]
Articles Tagged: v3
Get Mail Body
URL: v3/api/get-log-mail-body/{logId} Method: GET Description : Gets mail body Response: { “success”:true, “data”:{ “mail_body”:”test_body” } }
Delete Logs
URL: v3/api/delete-logs Method: DELETE Description : Deletes logs by category Parameters: Parameter Type Optional/Required Description categories array Required Array of logs that has to be deleted. Following are the keys : mail, cron, exception. For eg. [ ‘cron’, ‘exception’] for deleting cron-logs and exception logs delete_before string Optional The time before all logs should be […]
Approval Workflow List
URL : v3/api/admin/approval-workflow Method : GET Parameters: Parameter Type Optional/Required Description limit integer Optional Records per page page integer Optional Page number sort_by string Optional Order by column. Valid inputs: name, created_at and updated_at order string Optional Order of sorting. Valid inputs: asc & desc search string Optional Search string restricted boolean Optional To restrict […]
Approval Workflow Show
URL : v3/api/admin/approval-workflow/{id} Method : GET Segment: Parameter Type Optional/Required Description id Integer Required Approval workflow id. Parameters: none Response: { “success”: true, “data”: { “id”: 52, “name”: “Omnis iure minima fugiat qui odit eligendi sit quo.”, “user_id”: 173, “levels”: [{ “id”: 52, “name”: “Level 1”, “match”: […]
Approval Workflow Store / Update
URL : v3/api/admin/approval-workflow Method : POST Parameters: Parameter Type Optional/Required Description id Integer Optional Approval workflow id. Required for update. Id integer 0 indicates create operation. name string Required Approval workflow name. Max 255 char. Unique. levels array Required Approval workflow levels. Must be an associative array with level data. Levels: Parameter Type Optional/Required […]
Approval Workflow Delete
URL : v3/api/admin/approval-workflow/{id}/{type} Method : DELETE Segment: Parameter Type Optional/Required Description id Integer Required Approval workflow id / Level id type string Required Deletion type workflow / level Parameters: none Response: { “success”: true, “message”: “Approval workflow removed” } or { “success”: true, “message”: “Workflow level removed” }
Get Approval Workflow Status
URL: v3/api/ticket-approval-status/{ticket-id} Method: GET Description : Gets the details of all the approval workflow applied to the ticket and their current status Success Response: { “success”: true, “data”: [ { “id”: 224 “approval_workflow_id”: “194”, “name”: “test_workflow”, “ticket_id”: 417, “created_at”: “2018-10-11 10:01:55”, “updated_at”: “2018-10-11 10:01:55”, “approval_levels”: [ { “id”: 486 “status”: “PENDING”, “is_active”: 1, […]
Get Ldap Settings
URL : v3/api/ldap/settings Method : GET Response : { “success”:true, “data”:{ “id”:1, “domain”:”domain_name”, “username”:”username@user.com”, “password”:”wrong_password”, “search_bases”:[ { “id”:1, “ldap_id”:1, “user_type”:”agent”, “search_base”:”search base”, “department_ids”:[1,”2″], “organization_ids”:[1,”2″] }, { “id”:2, “ldap_id”:1, “User_type”:”agent”, “search_base”:”search base”, “department_ids”:[1,”2″], “organization_ids”:[1,”2″] } ] } }
Post Ldap Settings
URL : v3/api/ldap/settings Method : POST Query Parameters : Parameter Type Optional/Required Description domain string Required Domain of ldap server username string Required username password string Required password Response : { “success”:true, “message”:”Successfully saved” }