DocumentationWorkfrontWorkfront Guide

Get metadata for a file or folder

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

Returns metadata for the specified file or folder.

URL

GET /metadata?id=[document or folder ID]

Query Parameters

Name
Description
id

The ID of file or folder, as referenced by the webhook provider. This is different than Adobe Workfront's document ID. To get the metadata of the root directory, use the value '/'.

Note: The maximum length for the ID is 255 characters.

Response

Name
Type
Description
title
String
The name of the document or folder
kind
String
Specifies if this item is a file or folder ('file' or 'folder')
id
String
The id of the file or folder.
viewLink
String
The URL path used by a user to view the document in a browser window. The URL can be hosted by either the document provider or the native external storage provider.
downloadLink
String
The URL path used by a user to download the document in a browser window. The URL can be hosted by either the document provider or the native external storage provider.
mimeType
String
The MIME type for the file. (optional)
dateModified
String
Last time this file was modified (formatted RFC 3339 timestamp)
size
Long
The size of the file in bytes. (optional)
readOnly
Boolean
Indicates if this file or folder is read-only to the authenticated user.(optional)

Example: https://www.acme.com/api/metadata?id=12345

{
title:"My Document",
kind:"file"
id":"12345",
viewLink:"https://www.acme.com/viewDocument?id=12345",
downloadLink:"https://www.acme.com/downloadDocument?id=12345",
mimeType:"image/png",
dateModified:"2014­06­05T17:39:45.251Z",
size: "32554694"
}
NOTE
Error handling should be consistent across all API calls. See the “Error Handling” section below for details.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43