delete https://{domainname}/ca_apis/deleteScheduledData
Delete Scheduled Data API is used to delete the scheduled data inserted in the backend. Data is deleted based on row id. A sequence of numbers can be deleted in a single request by passing the range of row ids.
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
Header parameters
Parameter | Description |
---|---|
apiKey* | Your CloudAgent account API Key |
Content-Type | application/json |
Body Params
{
"userName":"xxxxx",
"rowId":"xxxx"}
Parameter | Description |
---|---|
userName | Your CouldAgent account username |
rowId* | Can be retrieved from Schedule Data status API |
Note
- Data can be deleted in below methods by passing desired row_id values
- Single record (example: row_id=1)
- Multiple numbers separated by commas ( example: row_id=2,3,5,6)
- Range of numbers by passing rage (example: row_id=3-10)
- Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
Success response | "status": "success" "message": { |
Invalid api_key | "status": "error" "message": "No data found" |
Missing row_id | "status": "error" "message": "Mandatory parameter row_id is missing |
Invalid row_id | "status": "error" "message": "No data found" |