Set Metadata By Tag
Leave feedback
On this page
This REST API allows to set document metadata new values choosing properties by exact tag and category name.
The following example demonstrates how to set metadata information to all properties with the “Creator” tag name.
# 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/set" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>" \
-d "{
"FileInfo": {
"FilePath": "documents\\input.docx",
"StorageName": ""
},
"Properties": [
{
"NewValue": "NewAuthor",
"Type": "String",
"SearchCriteria": {
"TagOptions": {
"ExactTag": {
"Name": "Creator",
"Category": "Person"
}
}
}
}
]
}"
{
"path": "metadata/set_metadata/documents/input_docx/input.docx",
"url": "https://api.groupdocs.cloud/v1.0/metadata/storage/file/metadata/set_metadata/documents/input_docx/input.docx",
"setCount": 1
}
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 SetOptions | |
{ | |
FileInfo = fileInfo, | |
Properties = new List<SetProperty> | |
{ | |
new SetProperty | |
{ | |
NewValue = "NewAuthor", | |
SearchCriteria = new SearchCriteria | |
{ | |
TagOptions = new TagOptions | |
{ | |
ExactTag = new Tag | |
{ | |
Name = "Creator", | |
Category = "Person" | |
} | |
} | |
}, | |
Type = "String" | |
} | |
} | |
}; | |
var request = new SetRequest(options); | |
var response = apiInstance.Set(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); | |
SetOptions options = new SetOptions(); | |
ArrayList<SetProperty> properties = new ArrayList<SetProperty>(); | |
SetProperty property = new SetProperty(); | |
SearchCriteria searchCriteria = new SearchCriteria(); | |
TagOptions tagOptions = new TagOptions(); | |
Tag tag = new Tag(); | |
tag.setName("Creator"); | |
tag.setCategory("Person"); | |
tagOptions.setExactTag(tag); | |
searchCriteria.setTagOptions(tagOptions); | |
property.setSearchCriteria(searchCriteria); | |
property.setNewValue("NewAuthor"); | |
property.setType("string"); | |
properties.add(property); | |
options.setProperties(properties); | |
FileInfo fileInfo = new FileInfo(); | |
fileInfo.setFilePath("documents/input.docx"); | |
options.setFileInfo(fileInfo); | |
SetRequest request = new SetRequest(options); | |
SetResult response = apiInstance.set(request); |
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.