Cloud Fax and Notifications API 2.5 Documentation
Common Types and Elements		Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  Common Elements  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

3.10 Stored Objects

A variety of data objects are stored in the EasyLink system as "stored objects". A StoredObjectId represents the data necessary to identify a particular stored object.

StoredObjectIdType


Tag Name
& type		#Description
StoredObjectIdType    
   @objKind
xs:string		1The type of object. These are not case-sensitive. Legal values are:
  • bannerfx
  • cancellationNotice
  • coversheet
  • coversheet_classic
  • emailBody
  • emaildisclaimerblock
  • emailSubject
  • letterhead
  • logo
  • mmcover
  • rmBlock
  • rpttmplt_col
  • sos_tts
  • systemData
  • textBlock
  • vscript
Not all of these values may be usable for specific functions, or may actually appear in results. There are other kinds of stored objects in the system which are not accessible through the Cloud Fax and Notifications API.
   @ownership
StoredObjectLevelType		0-1Indicates the ownership level (and therefore the visibility) of the stored object. Legal values are:
user
group
customer
system
If ownership is not specified, user ownership is usually presumed.
   @groupName
xs:string		0-1Specifies the user's primary Fax2Mail group name.
   @groupNo
xs:long		0-1Specifies the user's primary Fax2Mail group number.
   @b64charset
xs:string		0-1In order to transmit a StoredObjectId value that is in a character set incompatible with the XML document, the data can be sent in base64-encoded form, and the character set (ISO name) put in this attribute. If this attribute is present, the system will expect base64-encoded data as the value.

Stored Object Functions

The Cloud Fax and Notifications API currently supports these operations on stored objects, subject in some cases to ownership level restrictions:

Stored Object TypeCloud Fax and Notifications API Functions
CreateListRetrieveDelete
TextBlockTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
RmBlockTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
EmailBodyTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
EmailSubjectTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
CancellationNoticeTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
Letterhead StoredObjectList  
BannerFx StoredObjectList  
Logo StoredObjectList  
Report Templates StoredObjectList  
Text-to-speech templatesTTSObjectCreateStoredObjectListTTSRetrieveStoredObjectDelete
VoiceScriptsVoiceScriptCreateStoredObjectListVoiceScriptRetrieveStoredObjectDelete
MailMerge cover sheetsMMCoverSheetCreateStoredObjectListMMCoverSheetRetrieveStoredObjectDelete
EmailDisclaimerTextBlockCreateStoredObjectListTextBlockRetrieveStoredObjectDelete
F2M Email Filtering RulesF2MFilteringRulesCreate F2MFilteringRulesRetrieveStoredObjectDelete

In addition, TTSObjectPreview and MMCoverSheetPreview functions allow for the generation of a preview of text-to-speech templates or mailmerge coversheets - either stored in the system or based on data in the request.

 
    prev  next        Table of Contents  Common Elements  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy		 This information is subject to change. Please check frequently for updates.
Modified October 06, 2020