Cases API Reference
The case information can be collected through API key provided by Apptivo. It can also be updated through API, when updating
“isAddressUpdate=false&isCustomAttributesUpdate=false&isAddressDelete=false
” fields are mandatory.
In order to update address information then isAddressUpdate=true
, similarly for custom fields update isCustomAttributesUpdate=true
and for deleting the address information isAddressDelete=true
You can see the list of API methods for cases.
Web Method: getCasesConfigData
Purpose
You can use the getCasesConfigData method to get all the configuration data’s like Case Statuses, Case Types, Case Priorities and Assignees List.
Request API URL
https://api.apptivo.com/app/dao/v6/cases?a=getConfigData&apiKey=API_KEY&accessKey=ACCESS_KEY
Request Parameters
Parameter | Data Type | Description |
apiKey* | String | Apptivo business account API Key |
accessKey* | String | Apptivo business account Access Key |
* – Mandatory parameter
Output
This will return all the cases configuration data with JSON format.
Notes
- You can get these configuration values and use them while create the case.
Sample URL
https://api.apptivo.com/app/dao/v6/cases?a=getConfigData&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E
Web Method: createCase
Purpose:
You can use createCase method to create cases in Apptivo with default fields provided by application.
Request URL:
https://api.apptivo.com/app/dao/v6/cases?a=save&caseData={CASE_DATA}&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E
Request Parameters:
Parameter | Data Type | Description |
caseData* | JSON | Please see the sample request URL |
apiKey* | String | Apptivo API Key |
accessKey* | String | Apptivo Access Key |
* – Mandatory parameter
Output:
This will return the details of the created case with JSON format.
Notes:
You can get the caseStatus, caseStatusId, caseType, caseTypeId, casePriority, casePriorityId, assignedObjectRefName, assignedObjectId, assignedObjectRefId values from the getConfigData method.
Sample Request URL:
https://api.apptivo.com/app/dao/v6/cases?a=save&caseData={"assignedObjectRefName":"lead test","assignedObjectRefId":44479,"assignedObjectId":"8","needByDate":"30/08/2016","caseType":"Feature Request","caseTypeId":17586150,"caseStatus":"New","caseStatusId":17585765,"casePriority":"High","casePriorityId":17585762,"description":"testcase","customAttributes":[],"labels":[],"tags":[],"isDirtypage":null,"caseNumber":"Auto generated number","caseSourceName":"Website","caseSourceId":3,"caseSummary":"testcase create","caseEmail":"customer@gmail.com","caseCustomerId":501914,"caseCustomer":"testcustomer","updateAutocomplete":true,"dateResolved":null,"caseItem":null,"caseItemId":null,"caseProject":null,"caseProjectId":null,"assignees":[]}&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E
Web Method: updateCase
Purpose:
You can use createCase method to create cases in Apptivo with default fields provided by application.
Request URL:
https://api.apptivo.com/app/dao/v6/cases?a=update&caseData={CASE_DATA}&caseId={CASE_ID}&appId={APP_ID}&attributeName={Attribute_Name}&apiKey=API_KEY&accesKey=ACCESS_KEY
Request Parameters:
Parameter | Data Type | Description |
caseData* | JSON | {“id”: “327401”, “caseId”: 327401, “objectId”: 59, “caseNumber”: “2”, “caseStatus”: “New”, “caseStatusId”: 17585765, “caseType”: “Feature Request”, “caseTypeId”: 17586150, “casePriority”: “High”, “casePriorityId”: 17585762, “assignedObjectRefName”: “lead test″, “assignedObjectRefId”: 44479, “assignedObjectId”: 8, “caseSummary”: “Testsummary update”, “description”: “test update”, “caseItem”: “”, “caseItemFeature”: “”, “caseProject”: “”, “caseCustomer”: “testcustomer”, “caseCustomerId”: 501914, “caseContact”: “”, “lastUpdatedByName”: “”, “creationDate”: “”, “lastUpdateDate”: “”, “caseCustomer”: “”, “caseCustomerId”: null, “needByDate”: “30/08/2016”, “caseEmail”: “test@gmail.com”, “deleted”: 0, “caseStatusCode”: “1”, “isNotResponded”: “Y”, “isActive”: “Y”, “isResponded”: “N”, “resolvedWithinSla”: “N”, “timeElapsedToCloseCase”: 21907, “caseSourceName”: “Website”, “caseSourceId”: 3, “assignmentHistory”: [
], ], ], ], ], ], ], ], ], ], ], ], |
apiKey* | String | Apptivo API Key |
accessKey* | String | Apptivo Access Key |
* – Mandatory parameter
Output:
This will return the details of the updated case with JSON format.
Notes:
You can get the caseStatus, caseStatusId, caseType, caseTypeId, casePriority, casePriorityId, assignedObjectRefName, assignedObjectId, assignedObjectRefId values from the getConfigData method.
Sample Request URL:
https://api.apptivo.com/app/dao/v6/cases?a=update&caseData={"id":"327401","caseId":327401,"objectId":59,"caseNumber":"2","caseStatus":"New","caseStatusId":17585765,"caseType":"Feature Request","caseTypeId":17586150,"casePriority":"High","casePriorityId":17585762,"assignedObjectRefName":"lead test","assignedObjectRefId":44479,"assignedObjectId":8,"caseSummary":"Testsummary update","description":"test update","caseItem":"","caseItemFeature":"","caseProject":"","caseCustomer":"testcustomer","caseCustomerId":501914,"caseContact":"","needByDate":"30/08/2016","caseEmail":"test@gmail.com","deleted":0,"caseStatusCode":"1","isNotResponded":"Y","isActive":"Y","isResponded":"N","resolvedWithinSla":"N","timeElapsedToCloseCase":21907,"caseSourceName":"Website","caseSourceId":3,"assignmentHistory":[],"addresses":[],"customAttributes":[],"phoneNumbers":[],"emailAddresses":[],"labels":[],"removeLabels":[],"assignees":[],"worklogs":[],"caseStatusHistory":[{"id":120453,"objectId":59,"caseId":327401,"caseStatusName":"New","caseStatusId":17585765,"statusStartDate":"2016-08-30 02:12:08","previousStatusId":17585765,"firmId":193350,"createdBy":44753,"lastUpdatedBy":44753,"createdByName":"lead test","creationDate":"2016-08-30 02:12:07","lastUpdateDate":"2016-08-30 02:12:07","lastUpdatedByName":"lead test","version":0}],"firmId":193350,"createdBy":44753,"lastUpdatedBy":44753,"createdByName":"lead test","creationDate":"Aug 30, 2016 11:12:07 AM","lastUpdateDate":"Aug 30, 2016 11:12:07 AM","lastUpdatedByName":"lead test","version":0,"isChecked":false,"tags":[],"followUpDescription":"","isDirtypage":null,"removePhoneNumbers":[],"removeEmailAddresses":[],"lastUpdatedByObjectId":8,"lastUpdatedByObjectRefId":44479}&caseId=327401&appId=59&attributeName=["caseSummary","description","caseEmail"]&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E
Comments
0 comments
Please sign in to leave a comment.