Overview

The TMF667 API provides a standardized client interface to manage documents. This API manages the metadata related to a document.
Following block diagram provides a high-level overview of how the various components are involved in handling TMF667 API operations (GET, POST).

TMF667 Components

In general, we can consider the various use cases listed based on the operation you want to perform.

It is assumed that you have completed the following.

Enabling Access to Industry APIs
Ensuring that the required licenses and data packs are installed. For more information, refer Before you begin.

Following block diagram provides a sequence of operations involved.

I want to	Request Type	Example URL
Retrieve and display details of a particular document.	GET by ID	{https://MyDomainLoginUrl}//services/data/v63.0/connect/comms/document/v4/document/contentVersionId NOTE: For invalid product order ID, you will receive HTTP 404 error.
Based on the provided filter values, retrieve and display details of a particular document ID.	GET List by Filters	{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/document/v4/document?name=Testing NOTE: The requested fields will be part of output, if they have value.
List all the documents present in the system.	GET List	{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/document/v4/document
List all the documents present in the system based on the provided field values.	GET List by Fields	{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/document/v4/document?fields=name,status,description,creationdate,lastupdate,documenttype NOTE: The requested fields will be part of output, if they have value.
List documents based on criteria, limit the number of product orders to a maximum of specified limit, and display results from the page specified by offset.	GET List by Limit and Offset	{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/document/v4/document?pageLimit=2&offset=3
Create a new document by providing the required details.	POST	{https://MyDomainLoginUrl}/services/data/v63.0/connect/comms/document/v4/document

Consider you want to retrieve details of a particular product order. For example, document ID = 068xx0000004CQmAAM.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document/068xx0000004CQmAAM

Consider you want to retrieve details documents present in the system based on the applied filter.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document?name=Testing

Consider there are multiple documents in the system and you want to list all of them.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document

Consider you want to retrieve all the documents present in the system with provided field values.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document?fields=name,status,description,creationdate,lastupdate,documenttype

Consider you want to retrieve list of documents and apply required pagination query.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document?pageLimit=2&offset=3

NOTE: This request will display a list of records with a maximum of 2 records displayed from 3rd record.

Consider you want to create a new document.

NOTE:

Mandatory attributes are - name, attachment.url.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/document/v4/document