iSheets API version 2 - iSheet module - API - iSheet item - delete
OVERVIEW
To delete iSheet items - this supports multiple sheet items in a single call or all iSheet items.
DELETE
For iSheet item ID : /api/3/isheet/{isheetid}/items?itemids={itemids}
For external ID : /api/3/isheet/{isheetid}/items/byexternalid?externalids={externalids}
Parameter Name | Parameter Value | Description |
---|---|---|
isheetid |
number |
The ID of the iSheet |
itemids |
String |
The IDs of the iSheet item for example 1,2,3 or 'ALL' (to remove all records) |
externalid |
String |
External system ID which is linked with an iSheet item ID. You can get the external ID from the get all iSheet item api call. For example EX101,EX102,EX103 or 'ALL' (to remove all records where external id is set) |
Response
Case 1 : If there is an error in column data, the method will return a 403 http response for an unsuccessful request
Case 2 : If the method is processed correctly, it will return a 200 http response for a successful request
If the operation is successful, the API returns a progressive key resource object. Using the progressive key, an API user can see the status of an iSheet item. In the case of a failure, an error object is returned with the appropriate error code.
To get the status of an iSheet item based on a progressive key
POST /api/3/progressivekeystatus/{progressive_key}
Name | Type | Description |
---|---|---|
progressive_key | String |
This key is returned when a long-running operation is called and can be used to find the final status of the operation |
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<progressivekeyresponse>
<items>
<item>
<itemid>1086</itemid>
<externalid>0</externalid>
<status>SUCCESS</status>
<statuscode>200</statuscode>
<message>#Deleted successfully</message>
</item>
<item>
<itemid>1214</itemid>
<externalid>0</externalid>
<status>SUCCESS</status>
<statuscode>200</statuscode>
<message>#Deleted successfully</message>
</item>
</items>
</progressivekeyresponse>
If the operation is successful, the API returns a progressive key resource object with status of either 'in-progress', 'done', or 'failed' otherwise an error object is returned with the appropriate error code.
Just as a temporary fyi for anyone calling this EP and then the iSheet Item Create (for multiple items) EP right after, you might run in to a bit of a hiccup. If you see that your Create progressive key status might all return HTTP 200 responses, but the number of items in the iSheet is the not same amount submitted, pause your functionality/process/app/etc. in between the EP calls and that should fix this minor hiccup. Not sure when a resolution would be made by the dev side, but enforcing a pause in between Delete and Create EP calls will act as a temp solution for now.
Comments
1 Comments