cURL
curl --request GET \ --url https://api.fieldwise.ai/api/v1/documents/delete/external/{external_id}/preview \ --header 'X-API-Key: <api-key>'
{ "data": { "document_count": 123, "document_ids": [ 123 ] }, "success": true, "error": { "error_code": "RESOURCE_NOT_FOUND", "message": "Resource not found" }, "meta": { "timestamp": "2023-11-07T05:31:56Z", "version": "1.0" } }
Preview which document(s) would be deleted by external ID with version control.
Returns the count and IDs of documents that would be deleted.
If True, preview only the latest version. If False, preview all versions with this external_id.
Successful Response
Response data
Show child attributes
Schema for API error responses.
{ "error_code": "RESOURCE_NOT_FOUND", "message": "Resource not found"}
Metadata for API responses