TMF667 v4 Document Management API
The Document Management API (TMF667) offers a standardized approach for handling documents, especially in the context of partnerships. It enables both document creation and retrieval. This API manages key metadata associated with a document, including details like related parties (for example, author, reviewer, publisher), creation date, version, and lifecycle status. The actual content of the document is referenced by an associated Attachment, with binary content typically accessible through the Attachment.url attribute, which may point to a file or an HTTPS reference.
The Document Management API is certified by TM Forum.
- For TMF Open API release and specification version, see Industry API Version.
- For resource mappings, see TMF667 v4 Resource Mappings.
- For use cases, see TMF667 v4 Use Cases.
- The CommsCloud license must be enabled to invoke the TMF667 API.
- Supporting core entity for document is ContentDocument. The mappings are in reference to ContentVersion.
TMF667 v4 API uses the this URL format:
{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/document/v4/document.
To access and use the TMF667 v4 API:
- Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
- Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
- Trigger the API call. Refer the above section for sample URL. See TMF667 v4 Resource Mappings.
- Use the TMF667 API endpoints. See TMF667 v4 API Endpoints.