Cloud Fax and Notifications API 2.5 Documentation
StoredObjectList		Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  StoredObjectList  
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.
 

52.2 StoredObjectListRequest

StoredObjectList Overview   StoredObjectListResult

Tag Name
& type		#Description
StoredObjectListRequest   Namespace of this element is http://ws.easylink.com/StoredObjectList/2011/01
   SubmitId
xs:string		0-1Optional string identifying request, which will be echoed in result.
   ObjectStore
xs:string		1The store from which the stored object information is requested. This can be a specific EasyLink "domain" name, but using the generic system type "XDDS" or "MR" allows the Cloud Fax and Notifications API to choose the most appropriate available switch.
   FilterByObjectKind
FilterByObjectKindType		1This choice allows retrieving stored objects based on the object type and object ownership - for example, retrieving all text blocks at customer level or all TTS objects for a group.
   ObjKind
xs:string		1The type of object to list. These are not case-sensitive. Legal values are:
  • bannerfx
  • cancellationNotice
  • coversheet
  • coversheet_classic
  • emailBody
  • emaildisclaimerblock
  • emailSubject
  • letterhead
  • logo
  • mmcover
  • rmBlock
  • rpttmplt_col
  • sos_tts
  • textBlock
  • vscript
   OwnershipInfo
OwnershipInfoType		0-This optional element selects the ownership to be applied to the stored objects to be retrieved. Multiple ownership levels can be specified.
   Ownership
StoredObjectLevelType		1This indicates the level of ownership (and therefore the visibility) of the stored objects. Values are:
  • user
  • group
  • customer
  • domain
   GroupName
xs:string		0-1For "group" ownership, this is the Fax2Mail group name. Group names are not necessarily unique, but this may be sufficient to identify a group.
   GroupNo
xs:long		0-1For "group" ownership, this is the Fax2Mail group number. This is an alternative to using GroupName.
StoredObjectId
StoredObjectIdType		1Stored object identifier. This choice retrieves information about a specific stored object. See Stored Objects.
   RetrieveDescription
xs:boolean		0-1This optional element indicates whether additional description information stored with the listed objects is to be retrieved and returned in the result.
   UseBase64
xs:boolean		0-1Optional boolean value that affects the way data will be returned. See Character Sets. Default is "false".
   MaxListSize
xs:long		0-1This optional element restricts the number of stored objects to be returned in the result. Currently this is not functional.
 
    prev  next        Table of Contents  StoredObjectList  
© 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