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”: [

],
“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
}

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

  • >   CreateCase
  • >   updateCase

    User Manual >> Documentation >> Developer API >> Cases API Reference >> updateCase

    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”: [

    ],
    “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
    }

    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

  • >   createLead
  • >   updateLead