Get Metadata Tags Information

This REST API allows to obtain tags and properties information from document metadata. Endpoint accepts document storage path as input payload.

Operation traverses whole metadata tree packages and retrieve properties within the package.

The table below contains the full list of properties.

NameDescriptionComment
FileInfo.FilePathThe path of the document, located in the storage.Required.
FileInfo.StorageNameStorage nameCould be omitted for default storage.

Resource URI

HTTP POST ~/metadata/tags

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

cURL example

# Get JSON Web Token
# Ensure CLIENT_ID and CLIENT_SECRET are set as environment variables.
curl -v "https://api.groupdocs.cloud/connect/token" \
  -X POST \
  -d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json"

# Get document information (metadata tags)
curl -v "https://api.groupdocs.cloud/v1.0/metadata/info/tags" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -d '{ "FilePath": "/documents/input.docx" }'
# Get JSON Web Token
# Ensure CLIENT_ID and CLIENT_SECRET are set as environment variables.
curl.exe -v "https://api.groupdocs.cloud/connect/token" `
  -X POST `
  -d "grant_type=client_credentials&client_id=$env:CLIENT_ID&client_secret=$env:CLIENT_SECRET" `
  -H "Content-Type: application/x-www-form-urlencoded" `
  -H "Accept: application/json"

# Get document information (metadata tags)
curl.exe -v "https://api.groupdocs.cloud/v1.0/metadata/info/tags" `
  -X POST `
  -H "Content-Type: application/json" `
  -H "Accept: application/json" `
  -H "Authorization: Bearer $env:JWT_TOKEN" `
  -d '{ "FilePath": "/documents/input.docx" }'
rem Get JSON Web Token
rem Ensure CLIENT_ID and CLIENT_SECRET are set as environment variables.
curl -v "https://api.groupdocs.cloud/connect/token" ^
  -X POST ^
  -d "grant_type=client_credentials&client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%" ^
  -H "Content-Type: application/x-www-form-urlencoded" ^
  -H "Accept: application/json"

rem Get document information (metadata tags)
curl -v "https://api.groupdocs.cloud/v1.0/metadata/info/tags" ^
  -X POST ^
  -H "Content-Type: application/json" ^
  -H "Accept: application/json" ^
  -H "Authorization: Bearer %JWT_TOKEN%" ^
  -d "{ \"FilePath\": \"/documents/input.docx\" }"
{
    "rootPackage": {
        "packageName": "Root",
        "packageProperties": [],
        "innerPackages": [
            {
                "packageName": "FileFormat",
                "packageProperties": [
                    {
                        "name": "FileFormat",
                        "value": null,
                        "propertyType": "Empty",
                        "accessLevel": "Read",
                        "tags": [
                            {
                                "name": "FileFormat",
                                "category": "Content"
                            }
                        ]
                    },
                    {
                        "name": "MimeType",
                        "value": null,
                        "propertyType": "Empty",
                        "accessLevel": "Read",
                        "tags": [
                            {
                                "name": "FileFormat",
                                "category": "Content"
                            }
                        ]
                    },
                    {
                        "name": "WordProcessingFileFormat",
                        "value": null,
                        "propertyType": "Empty",
                        "accessLevel": "Read",
                        "tags": [
                            {
                                "name": "FileFormat",
                                "category": "Content"
                            }
                        ]
                    }
                ],
                "innerPackages": []
            },
            ...            
        ]
    }
}

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.