Extract Metadata By Property Name

This REST API allows to extract metadata properties from the document choosing the properties to extract by name.

cURL example

The following example demonstrates how to extract metadata information from all properties that have “Date” string in names.

# First get JSON Web Token
# Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. 
# Kindly place Client Id in client_id and Client Secret in "client_secret" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-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 join several documents into one
curl -v "https://api.groupdocs.cloud/v1.0/metadata" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>" \
-d "{
    "FileInfo": {
        "FilePath": "documents\\input.docx",
        "StorageName": ""
    },
    "SearchCriteria": {
        "NameOptions": {
            "Value": "Date"
        }
    }
}"
{
    "properties": [
        {
            "name": "CommentCreatedDate",
            "value": "03/22/2016 20:11:00",
            "propertyType": "DateTime"
        }
    ]
}

SDK examples

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Metadata Cloud SDKs along with working examples, to get you started in no time. Please check Available SDKs article to learn how to add an SDK to your project.

// For complete examples and data files, please go to https://github.com/groupdocs-metadata-cloud/groupdocs-metadata-cloud-dotnet-samples
string MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
string MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
var configuration = new Configuration(MyAppSid, MyAppKey);
var apiInstance = new MetadataApi(configuration);
var fileInfo = new FileInfo
{
FilePath = "documents/input.docx"
};
var options = new ExtractOptions
{
FileInfo = fileInfo,
SearchCriteria = new SearchCriteria
{
NameOptions = new NameOptions
{
Value = "Date"
}
}
};
var request = new ExtractRequest(options);
var response = apiInstance.Extract(request);
// For complete examples and data files, please go to https://github.com/groupdocs-metadata-cloud/groupdocs-metadata-cloud-java-samples
String MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
String MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
MetadataApi apiInstance = new MetadataApi(configuration);
ExtractOptions options = new ExtractOptions();
SearchCriteria searchCriteria = new SearchCriteria();
NameOptions nameOptions = new NameOptions();
nameOptions.setValue("Date");
searchCriteria.setNameOptions(nameOptions);
options.setSearchCriteria(searchCriteria);
FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("documents/input.xlsx");
options.setFileInfo(fileInfo);
ExtractRequest request = new ExtractRequest(options);
ExtractResult response = apiInstance.extract(request);