Delete method allows to remove all added annotations.
API usage
There are steps that usage of GroupDocs.Annotation Cloud consists of:
Upload input document into cloud storage and other files, like image annotation
Add annotation
Download document with annotations
Delete annotations
HTTP POST ~/annotation/remove
Swagger UI lets you call this REST API directly from the browser.
cURL example
// First get JSON Web Token
// Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. Kindly place Client Id in the "client_id" and Client Secret in the "client_secret" arguments.
curl-v"https://api.groupdocs.cloud/connect/token"\-XPOST\-d"grant_type=client_credentials&client_id=xxxx&client_secret=xxxx"\-H"Content-Type: application/x-www-form-urlencoded"\-H"Accept: application/json"// cURL example to delete annotations in the document
curl-v"https://api.groupdocs.cloud/v2.0/annotation/remove"\-XPOST\-H"Content-Type: application/json"\-H"Accept: application/json"\-H"Authorization: Bearer <jwt token>"\-d"{ \"FileInfo\": { \"FilePath\": \"annotationdocs/input.docx\" }, \"AnnotationIds\": [ 1, 2, 3 ], \"OutputPath\": \"Output/output.docx\"}"
The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.
// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-dotnet-samplesstringMyAppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloudstringMyAppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloudvarconfiguration=newConfiguration(MyAppSid,MyAppKey);varapiInstance=newAnnotateApi(configuration);varfileInfo=newFileInfo{FilePath="one-page.docx"};varoptions=newRemoveOptions();options.FileInfo=fileInfo;options.AnnotationIds=newList<int?>{1,2,3};options.OutputPath="Output/output.docx";varrequest=newRemoveAnnotationsRequest(options);varlink=apiInstance.RemoveAnnotations(request);Console.WriteLine("DeleteAnnotations: Annotations deleted: "+link.Title);
// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
StringMyAppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
StringMyAppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
Configurationconfiguration=newConfiguration(MyAppSid,MyAppKey);AnnotateApiapiInstance=newAnnotateApi(configuration);// Create request object.
FileInfofileInfo=newFileInfo();fileInfo.setFilePath("Annotationdocs\\input.docx");RemoveOptionsoptions=newRemoveOptions();options.setFileInfo(fileInfo);options.setAnnotationIds(Arrays.asList(1,2,3));options.setOutputPath("Output/output.docx");RemoveAnnotationsRequestrequest=newRemoveAnnotationsRequest(options);// Executing api method.
AnnotationApiLinkresult=apiInstance.removeAnnotations(request);System.out.println("DeleteAnnotation: Annotation deleted from document: "+result.getHref());
// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-php-samples
useGroupDocs\Annotation\Model;useGroupDocs\Annotation\Model\Requests;$AppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$AppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$configuration=newGroupDocs\Annotation\Configuration();$configuration->setAppSid($AppSid);$configuration->setAppKey($AppKey);$apiInstance=newGroupDocs\Annotation\AnnotateApi($configuration);$fileInfo=newGroupDocs\Annotation\Model\FileInfo();$fileInfo->setFilePath("input\\input.docx");$options=newGroupDocs\Annotation\Model\RemoveOptions();$options->setFileInfo($fileInfo);$options->setAnnotationIds([1,2,3]);$options->setOutputPath("Output\\output.docx");$request=newGroupDocs\Annotation\Model\Requests\removeAnnotationsRequest($options);$result=$apiInstance->removeAnnotations($request);echo"DeleteAnnotations: Annotations deleted. ".$result->getHref();
// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node-samples
global.annotation_cloud=require("groupdocs-annotation-cloud");global.appSid="XXXX-XXXX-XXXX-XXXX";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.appKey="XXXXXXXXXXXXXXXX";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.annotateApi=annotation_cloud.AnnotateApi.fromKeys(appSid,appKey);letfileInfo=newannotation_cloud.FileInfo();fileInfo.filePath="input\\input.docx";letoptions=newannotation_cloud.RemoveOptions();options.fileInfo=fileInfo;options.annotationIds=[1,2,3];options.outputPath="Output/output.docx";// Remove annotations
letresult=awaitannotateApi.removeAnnotations(newannotation_cloud.RemoveAnnotationsRequest(options));console.log("DeleteAnnotations: annotations delete: "+result.href);
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python-samplesimportgroupdocs_annotation_cloudapp_sid="XXXX-XXXX-XXXX-XXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloudapp_key="XXXXXXXXXXXXXXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloudapi=groupdocs_annotation_cloud.AnnotateApi.from_keys(app_sid,app_key)file_info=FileInfo()file_info.file_path="annotationdocs\\input.docx"options=RemoveOptions()options.file_info=file_infooptions.annotation_ids=[1,2,3]options.output_path="Output\\output.docx"request=RemoveAnnotationsRequest(options)result=api.remove_annotations(request)print("RemoveAnnotations: Annotations removed: "+result['href'])
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samplesrequire'groupdocs_annotation_cloud'$app_sid="XXXX-XXXX-XXXX-XXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloud$app_key="XXXXXXXXXXXXXXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloud$api=GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid,$app_key)file_info=GroupDocsAnnotationCloud::FileInfo.new()file_info.file_path="annotationdocs\\input.docx"options=GroupDocsAnnotationCloud::RemoveOptions.new()options.file_info=file_infooptions.annotation_ids=[1,2,3]options.output_path="Output/output.docx"$request=GroupDocsAnnotationCloud::RemoveAnnotationsRequest.new(options)# Executing an API.$response=$api.remove_annotations($request)puts("RemoveAnnotations: Annotations deleted from document: "+$response.href)
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.