Extract Metadata

This REST API allows to extract metadata from the documents.

With this API you can extract metadata with following features:

  • Extract whole metadata properties tree;
  • Extract properties with specified tag;
  • Extract properties with specified name;
  • Extract properties with specified value;

The table below contains the full list of properties that can be specified when extracting metadata from the document.

FileInfo.FilePathThe path of the document, located in the storage.Required.
FileInfo.StorageNameStorage nameCould be omitted for default storage.
SearchCriteriaOptions to find properties.Required
SearchCriteria.TagOptionsOptions to find property by tag.Required if searching by tag
TagOptions.PossibleNameA part or a possible tag name.If a part of tag name is known
TagOptions.ExactTagOptions to specify exact tag.If tag and category name is known. More accurate
ExactTag.NameName of the tag.Required
ExactTag.CategoryCategory of the tag.Required
SearchCriteria.NameOptionsOptions to find property by name.Required if searching by name
NameOptions.ValueThe value for name matching.Required
NameOptions.MatchOptionsSpecifies how to find property name.
MatchOptions.ExactPhraseValue indicating whether to match exact string phrase.
MatchOptions.IsRegexValue indicating whether to match by regular expression.
SearchCriteria.ValueOptionsOptions to find property by value.Required if searching by value
ValueOptions.ValueSpecifies value of property to find.Required
ValueOptions.TypeType of property value.

Resource URI

HTTP POST ~/metadata

Swagger UI lets you call this REST API directly from the browser. 

Use Cases