TMF667 Document Management API User Guide v4.0.0

This document is the user guide of the REST API for Document and DocumentSpecification management. It includes the model definition as well as all available operations.

The Document API manages the meta-data related to a Document, such as the related parties (like author, reviewer, publisher), the creation date, version, and lifecycle status. The body of the Document itself is either held or referred to by the associated Attachment. Binary content might be encoded into the Attachment.content attribute, or (if by reference) referred to by the Attachment.url attribute – such as a file: or https: reference. Attachment is not a managed resource since the binary content is assumed to be resident in a Content Management System and not created by an API – only retrieved from or referred to.

Each Document type (such as PDF file, Word document, Image or Video) might be described by its own DocumentSpecification. This resource manages the collection of characteristics that detail the contained media type. For example, the DocumentSpecification for a “book” might have characteristics such as number of pages language, an ISBN, publisher and dimensions.

General Information

Document series: TMF667
Document version: 4.0.0
Status: TM Forum Approved
Document type: Guidebook
Team approved: 05-Dec-2021
IPR mode: RAND
Published on: 01-Feb-2022
TM Forum Approved: 18-Mar-2022
Date modified: 22-Mar-2022