TMF667 v4 Resource Mappings
Before using the TMF667 resource mappings, refer the following.
- TMF667 API manages the metadata related to a document.
- POST Method
- The body of the document itself is referred to by the associated Attachment. Only URL upload is supported in POST method.
- Mandatory POST attributes are -
name
,attachment.url
.
- The
documentType
attribute will have salesforce autopopulated value ofLINK
. - Filtering is supported for
name
attribute. Full-word search only. - Attribute selection is supported for
name
,documentType
,status
,description
,creationdate
,lastupdate
.
- The CommsCloud license is enabled to invoke the TMF667 API.
- Supporting core entity for document is ContentDocument. The mappings are in reference to ContentVersion.
TMF Field | Description property | Is Mandatory? | Field Type | Salesforce Mapping | Supported Method |
---|---|---|---|---|---|
creationDate | The date and time the document was created | No | DateTime | CreatedDate | GET |
description | Free-text description of the document | No | String | Description | GET, POST |
documentType | Name of the document type | No | String | FileType | GET |
href | Hyperlink reference | No | uri | - | GET |
id | Unique identifier | No | String | ContentVersionId | GET |
lastUpdate | The date and time the document was last modified | No | DateTime | LastModifiedDate | GET |
name | A string used to give a name to the document | Yes | String | Title | GET, POST |
status | The life cycle state of the document | No | enum | PublishStatus | GET |
attachment | A list of attachment ref or values | No | List | Attachment | GET, POST |
- | - | - | - | ContentDocumentId. NOTE: This is not part of TMF, but this ID represents the actual Salesforce content document ID. If any other API includes an attachment subresource, this ID will be referenced in its POST payload | GET |
TMF Field | Description property | Is Mandatory? | Field Type | Salesforce Mapping | Supported Method |
---|---|---|---|---|---|
attachmentType | Attachment type such as video, picture | No | string | - | GET |
url | An URI. Remote reference to the content if web address contains information about the location of the webpage | Yes | uri | contentUrl | GET, POST |