Embedded Files
Interface
Interface
It allows you:
to insert new: request (tickets)
to process (update) existing request
to view request
Prerequisites:
In order to use this API Method for PUT there must be accomplished the following requirements in SocrateCloud:
to have the CRM setup completed:
Request Type (e.g. Incident, BUG, Question etc)
Status Status (e.g. Registered, Allocated, Closed etc)
Processing Group (ex. Service Desk, Technical Support etc)
Business Partner
Business Partner Project
Columns that can be used as filters:
Organization
RequestNo
RequestType
BPartner
Active
Open
SalesRep
SalesRepEmail
BPartnerName
Region_ID
RegionName
SerNo
Project
Created
CreatedBy
Updated
UpdatedBy
DateNextAction
Asset_ID
AssetValue
Modified
ModifiedBy
Actions can be done:
list
insert
update
delete
updateStatus
Request fields (Master Document)
A request has the following structure:
Request (master document) which contains data about the request:
Request No.
Request Type
Summary
Customer etc
Request results (lines to Request, see Request Results) which contains the actions registered to a specific request
Result: action, results description
Activity
SpentTime
API Method
API Method
List:
List:
URL: https://api.socratecloud.com/webapi/rest/request/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}
Method: GET
Return: JSON object with next format:
{
"data": [
{
"Organization": "Demo SRL",
"Created": "2014-05-05 12:10:08",
"CreatedBy": "SuperUser",
"Updated": "2014-05-05 12:14:14",
"UpdatedBy": "SuperUser",
"Active": true,
"RequestNo": "1000500",
"DueType":"Due",
"BPartner": "UserTitular",
"BPartnerName": "User Titular",
"BPartnerContact": null,
"RequestType": "Sales",
"Status": "Open",
"RequestCategory": null,
"RequestGroup": "Sales Group",
"Resolution":"Rezolvat",
"Priority": "Medium",
"PriorityUser":"Medium",
"Subject": "some_subject",
"Summary": "some_text",
"ConfidentialType":"Partner Confidential",
"IsInvoiced":false,
"RequestAmt":0,
"Role":"Admin",
"QtyPlan":3,
"CumulatedQty":3,
"DateStartPlan":"2014-05-05 12:14:14",
"DateCompletePlan":"2014-05-05 12:14:14",
"Project": "some_project",
"ProjectPhase":null,
''ProductFamily":null,
"ProductFamilyVersion":null,
"SalesRep": null,
"SalesRepEmail": "admin@t00.ro",
"SalesRepBPartner": "1000002"
"Region_ID": 2140900008,
"RegionName": "Brasov",
"LastResult": null,
"DateLastAction": "2014-05-05 12:14:14",
"DateNextAction": "2020-03-05 00:00:00"
"Asset_ID": null,
"AssetName":null,
"AssetValue": null,
"SerNo": null
}
],
"totalRows": 1
}
Create:
Create:
URL: https://api.socratecloud.com/webapi/rest/request/create/{version}?accessToken={access_token}
Method: POST
Return: request no for success or error message (start with "ERROR: ")
Data format:
{
"Organization": "Demo SRL",
"Active": true,
"DueType":"Due",
"BPartner": "UserTitular",
"BPartnerContact": null,
"RequestType": "Sales",
"Status": "Open",
"RequestCategory": null,
"RequestGroup": "Sales Group",
"Resolution":"Rezolvat",
"Priority": "Medium",
"PriorityUser":"Medium",
"Subject": "some_subject",
"Summary": "some_text",
"ConfidentialType":"Partner Confidential",
"IsInvoiced":false,
"RequestAmt":0,
"Role":"Admin",
"QtyPlan":3,
"DateStartPlan":"2014-05-05 12:14:14",
"DateComplatePlan":"2014-05-05 12:14:14",
"Project": "some_project",
"ProjectPhase":null,
"ProductFamily":null,
"ProductFamilyVersion":null,
"Asset_ID": 1004522,
"AssetValue": "Test11.10",
"SalesRep": "AdminTitular"
}
Update:
Update:
URL: https://api.socratecloud.com/webapi/rest/request/update/{version}?accessToken={access_token}&RequestNo={request_no}
Method: POST
Return: request no for success or error message (start with "ERROR: ")
Data format:
{
"Organization": "Demo SRL",
"Active": true,
"DueType":"Datorat",
"BPartner": "UserTitular",
"BPartnerContact": null,
"RequestType": "Sales",
"Status": "Open",
"RequestCategory": null,
"RequestGroup": "Sales Group",
"Resolution":"Rezolvat",
"Priority": "Medium",
"PriorityUser":"(C) Medie",
"Subject": "some_subject",
"Summary": "some_text",
"ConfidentialType":"Partner Confidential",
"IsInvoiced":false,
"RequestAmt":0,
"Role":"Admin",
"QtyPlan":3,
"DateStartPlan":"2014-05-05 12:14:14",
"DateComplatePlan":"2014-05-05 12:14:14",
"Project": "some_project",
"ProjectPhase":null,
"ProductFamily":null,
"ProductFamilyVersion":null,
"Asset_ID": 1004522,
"AssetValue": "Test11.10",
}
UpdateStatus:
UpdateStatus:
URL: https://api.socratecloud.com/webapi/rest/request/updateStatus/{version}?accessToken={access_token}&RequestNo={request_no}
Method: POST
Return: request no for success or error message (start with "ERROR: ")
Data format:
{
"Organization": "Demo SRL",
"BPartner": "UserTitular",
"RequestType": "Sales",
"StatusName": "Open",
"SalesRep": null,
"DateNextAction": "2014-05-05 12:14:14"
}
Get attachment:
Get attachment:
URL: https://api.socratecloud.com/webapi/rest/request/attachment/{version}?accessToken={access_token}&RequestNo={request_no}&FileName={file_name}
Method: GET
Return: File or 204/"No Content" if no attachment found
Add attachment:
Add attachment:
URL: https://api.socratecloud.com/webapi/rest/request/attachment/add/{version}?accessToken={access_token}&RequestNo={request_no}&FileName={file_name}
Method: POST
Return 'Ok' for success or error message (start with "ERROR: ")
Delete attachment:
Delete attachment:
URL: https://api.socratecloud.com/webapi/rest/request/attachment/delete/{version}?accessToken={access_token}&RequestNo={request_no}&FileName={file_name}
Method: POST
Return 'Ok' for success or error message (start with "ERROR: ")
List attachment:
List attachment:
URL: https://api.socratecloud.com/webapi/rest/request/attachment/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}&RequestNo={request_no}
Method: GET
Return: JSON with the following format
{
"data": [
{
"FileName": "20x20.gif",
"Bytes": 784
},
{
"FileName": "800x600.jpg",
"Bytes": 7767
}
],
"totalRows": 2
}
Page updated
Report abuse