Get method allows to retrieve all added annotations for given document as list of json objects
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
Extract or Delete annotations
HTTP POST ~/annotation/extract
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 extract annotations
curl-v"https://api.groupdocs.cloud/v2.0/annotation/extract"\-XPOST\-H"Content-Type: application/json"\-H"Accept: application/json"\-H"Authorization: Bearer <jwt token>"\-d"{ \"FilePath\": \"annotationdocs/input.docx\"}"
[{"id":0,"text":"This is ellipse annotation","textToReplace":null,"horizontalAlignment":0,"verticalAlignment":0,"creatorId":0,"creatorName":"Anonym A.","creatorEmail":null,"box":{"x":100,"y":100,"width":100,"height":100},"points":null,"pageNumber":0,"annotationPosition":null,"svgPath":null,"type":4,"replies":[{"id":0,"userId":0,"userName":null,"userEmail":null,"comment":"First comment","repliedOn":"2020-10-02T06:52:01.376Z","parentReplyId":0},{"id":0,"userId":0,"userName":null,"userEmail":null,"comment":"Second comment","repliedOn":"2020-10-02T06:52:01.376Z","parentReplyId":0}],"createdOn":"2020-10-02T06:52:01.376Z","fontColor":null,"penColor":null,"penWidth":null,"penStyle":null,"backgroundColor":null,"fontFamily":null,"fontSize":null,"opacity":null,"angle":null,"url":null,"imagePath":null}]
SDK examples
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="input.docx"};varresponse=apiInstance.Extract(newExtractRequest(fileInfo));Console.WriteLine("ExtractAnnotations: annotations count = "+response.Count);
// 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");ExtractRequestrequest=newExtractRequest();request.setfileInfo(fileInfo);// Executing api method.
List<AnnotationInfo>response=apiInstance.extract(request);System.out.println("GetAnnotations: annotations count = "+response.size());
// 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");$request=newGroupDocs\Annotation\Model\Requests\extractRequest($fileInfo);$result=$apiInstance->extract($request);echo"GetAnnotations: annotations count = ",count($result);
// 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";letresult=awaitannotateApi.extract(newannotation_cloud.ExtractRequest(fileInfo));console.log("GetAnnotations: annotations count = "+result.length);
# 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"request=ExtractRequest(file_info)result=api.extract(request)print("ExtractAnnotations: annotations count: "+str(len(result)))
# 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"$request=GroupDocsAnnotationCloud::ExtractRequest.new(file_info)# Executing an API.$response=$api.extract($request)puts("ExtractAnnotations: annotations count = "+$response.length.to_s)
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.