InfoBurst Enterprisewiki.infosol.com/infoburst/images/7/7e/Infoburst_web...This API allows you to integrate aspects of report distribution and/or management of InfoBurst objects into

InfoBurst Enterprise

1 © InfoSol Inc 2008-2012


Web Service API

Version 2012.8 b120 - Rev date August 9th 2012



Table of Contents Introduction ................................................................................................................................................ 21

General usage notes – Date parameters .................................................................................................... 21

Referencing the SOAP service ..................................................................................................................... 22

Service Information and Management ................................................................................................... 23

System Information............................................................................................................................. 23

System Activity .................................................................................................................................... 24

Is the server available? ....................................................................................................................... 24

Setting the system message ............................................................................................................... 24

System Shutdown ............................................................................................................................... 25

Token Management .................................................................................................................................... 26

Logon Token ............................................................................................................................................ 26

Release Token ......................................................................................................................................... 26

GetTokenInfo .......................................................................................................................................... 27

SetTokenClientInfo .................................................................................................................................. 27

SaveAppSetting ....................................................................................................................................... 28

GetAppSetting ......................................................................................................................................... 28

GetAppSettings ....................................................................................................................................... 28

ClearAppSettings ..................................................................................................................................... 29

GetUserAppSettings ................................................................................................................................ 29

SaveUserAppSetting ................................................................................................................................ 29

ClearUserAppSettings ............................................................................................................................. 30

System Management .................................................................................................................................. 31

User Functions ........................................................................................................................................ 31

GetUsers .............................................................................................................................................. 31

GetNextUsers ...................................................................................................................................... 31

GetUsersByRole .................................................................................................................................. 32

GetNextUsersByRole ........................................................................................................................... 32

CreateUser .......................................................................................................................................... 33

GetUser ............................................................................................................................................... 33



GetUserLogons .................................................................................................................................... 33

GetAllUserLogons ................................................................................................................................ 34

GetUserDBLogons ............................................................................................................................... 34

GetUserGroups ................................................................................................................................... 34

ChangeUserPassword ......................................................................................................................... 35

ModifyUser ......................................................................................................................................... 36

DeleteUser .......................................................................................................................................... 36

AddUserLogon ..................................................................................................................................... 36

ModifyUserLogon ................................................................................................................................ 37

TestUserLogon .................................................................................................................................... 37

RemoveUserLogon .............................................................................................................................. 38

AddUserDBLogon ................................................................................................................................ 38

ModifyUserDBLogon ........................................................................................................................... 39

RemoveUserDBLogon ......................................................................................................................... 39

GetUserCache ..................................................................................................................................... 40

GetNextUserCache .............................................................................................................................. 40

Platform functions .................................................................................................................................. 41

GetPlatforms ....................................................................................................................................... 41

CreatePlatform .................................................................................................................................... 41

Platform_ModifyQueue ...................................................................................................................... 43

GetPlatform......................................................................................................................................... 44

ModifyPlatform ................................................................................................................................... 44

DeletePlatform .................................................................................................................................... 44

Group functions ...................................................................................................................................... 45

GetGroups ........................................................................................................................................... 45

GetNextGroups ................................................................................................................................... 45

CreateGroup ........................................................................................................................................ 45

GetGroup ............................................................................................................................................ 46

ModifyGroup ....................................................................................................................................... 46

GetGroupMembers ............................................................................................................................. 46

AddUserToGroup ................................................................................................................................ 47



RemoveUserFromGroup ..................................................................................................................... 47

DeleteGroup ........................................................................................................................................ 47

Folder Management ................................................................................................................................... 48

GetRootFolders ....................................................................................................................................... 48

GetNextRootFolders ............................................................................................................................... 48

GetSubFolders ......................................................................................................................................... 49

GetNextSubFolders ................................................................................................................................. 49

GetUserRootFolders................................................................................................................................ 50

GetNextUserRootFolders ........................................................................................................................ 50

CreateSubFolder ..................................................................................................................................... 51

DeleteFolder ........................................................................................................................................... 51

GetObjectsInFolder ................................................................................................................................. 52

GetNextObjectsInFolder ......................................................................................................................... 54

Folder_Allow ........................................................................................................................................... 54

Folder_Deny ............................................................................................................................................ 55

Folder_GetACL ........................................................................................................................................ 55

Interfacing with a Document Platform ....................................................................................................... 56

Platform_GetRootFolders ....................................................................................................................... 56

Platform_GetNextRootFolders ............................................................................................................... 56

Platform_GetSubFolders ......................................................................................................................... 57

Platform_GetNextSubFolders ................................................................................................................. 57

Platform_GetObjectsInFolder ................................................................................................................. 58

Platform_GetNextObjectsInFolder ......................................................................................................... 58

Platform_GetObjectID ............................................................................................................................ 59

Platform_GetGroups ............................................................................................................................... 59

Platform_GetNextGroups ....................................................................................................................... 59

Platform_GetUsers ................................................................................................................................. 60

Platform_GetNextUsers .......................................................................................................................... 60

Platform_GetCategories ......................................................................................................................... 61

Platform_GetNextCategories .................................................................................................................. 61

Platform_OpenDocument ....................................................................................................................... 62



Platform_CloseDocument ....................................................................................................................... 62

Platform_SetParameter .......................................................................................................................... 62

Platform_SetFilter ................................................................................................................................... 63

Platform_Refresh .................................................................................................................................... 63

Platform_Export ...................................................................................................................................... 63

Platform_GetExportedFiles ..................................................................................................................... 64

Platform_GetReportParts ....................................................................................................................... 64

Platform_QueryInfoStore ....................................................................................................................... 65

Platform_GetNextQueryInfoStore .......................................................................................................... 65

Cataloging/Recataloging Documents .......................................................................................................... 66

Catalog_FromPlatform ............................................................................................................................ 66

Catalog_FromFileSystem ........................................................................................................................ 67

Recatalog ................................................................................................................................................. 68

Working with Document Objects ................................................................................................................ 69

GetObject_Document ............................................................................................................................. 69

ModifyObject_Document ....................................................................................................................... 69

Document_GetAllReportVariables.......................................................................................................... 70

Document_GetAllReportTabs ................................................................................................................. 70

Document_GetReportParts .................................................................................................................... 70

Document_GetParameterLOV ................................................................................................................ 71

Document_GetNextParameterLOV ........................................................................................................ 71

Document_CreateMultiColumnList ........................................................................................................ 72

Working with Text Objects .......................................................................................................................... 73

CreateObject_Text .................................................................................................................................. 73

GetObject_Text ....................................................................................................................................... 73

ModifyObject_Text ................................................................................................................................. 74

Working with Database Connection Objects .............................................................................................. 75

CreateObject_DBConnection .................................................................................................................. 75

GetObject_DBConnection ....................................................................................................................... 76

DBConnection_Test ................................................................................................................................ 76

DBConnection_GetTables ....................................................................................................................... 76



DBConnection_GetTableSchema ............................................................................................................ 77

DBConnection_GetSystemDSN ............................................................................................................... 77

ModifyObject_DBConnection ................................................................................................................. 78

CreateObject_DBQry............................................................................................................................... 79

GetObject_DBQry ................................................................................................................................... 80

GetObject_DBConnectionQueries .......................................................................................................... 80

ModifyObject_DBQry .............................................................................................................................. 80

DeleteObject_DBQry ............................................................................................................................... 81

DBQry_Execute ....................................................................................................................................... 81

DBQry_GetNextExecute .......................................................................................................................... 81

DBQry_GetColumns ................................................................................................................................ 82

DBQry_QueueImagePreview .................................................................................................................. 82

Working with Ldap Connection Objects ..................................................................................................... 83

CreateObject_LdapConnection ............................................................................................................... 83

GetObject_LdapConnection .................................................................................................................... 84

ModifyObject_LdapConnection .............................................................................................................. 84

Ldap_GetRootDN .................................................................................................................................... 85

Ldap_ExecuteSearch ............................................................................................................................... 85

Working with List Objects ........................................................................................................................... 86

CreateObject_List .................................................................................................................................... 86

GetObject_List ........................................................................................................................................ 86

ModifyObject_List ................................................................................................................................... 87

Working with FileList Objects ..................................................................................................................... 88

CreateObject_FileList .............................................................................................................................. 88

GetObject_FileList ................................................................................................................................... 89

FileList_GetValues ................................................................................................................................... 89

ModifyObject_FileList ............................................................................................................................. 90

Working with MultiColumnList Objects ...................................................................................................... 91

CreateObject_MultiColumnList .............................................................................................................. 91

GetObject_MultiColumnList ................................................................................................................... 92

ModifyObject_MultiColumnList .............................................................................................................. 92



MultiColumnList_AddColumn ................................................................................................................. 93

MultiColumnList_AddColumnsFromDocument ...................................................................................... 93

MultiColumnList_AddColumnsFromBurstDocument ............................................................................. 94

MultiColumnList_DeleteColumn ............................................................................................................. 95

MultiColumnList_RenameColumn .......................................................................................................... 95

MultiColumnList_AddDelimitedRow ...................................................................................................... 96

MultiColumnList_GetColumns ................................................................................................................ 96

MultiColumnList_AddRow ...................................................................................................................... 97

MultiColumnList_ModifyRow ................................................................................................................. 97

MultiColumnList_InsertRow ................................................................................................................... 98

MultiColumnList_GetRowCount ............................................................................................................. 98

MultiColumnList_GetRows ..................................................................................................................... 98

MultiColumnList_GetRowValues ............................................................................................................ 99

MultiColumnList_SetRowValues ............................................................................................................. 99

MultiColumnList_DeleteRow ................................................................................................................ 100

MultiColumnList_Import ....................................................................................................................... 100

Working with LdapList Objects ................................................................................................................. 101

CreateObject_LdapList .......................................................................................................................... 101

GetObject_LdapList ............................................................................................................................... 101

LdapList_GetValues ............................................................................................................................... 102

ModifyObject_LdapList ......................................................................................................................... 102

Working with XIList Objects ...................................................................................................................... 103

CreateObject_XIList .............................................................................................................................. 103

GetObject_XIList ................................................................................................................................... 103

XIList_GetValues ................................................................................................................................... 104

ModifyObject_XIList .............................................................................................................................. 104

Working with Delivery Template Objects ................................................................................................. 105

CreateObject_DeliveryTemplate .......................................................................................................... 105

GetObject_DeliveryTemplate ............................................................................................................... 105

ModifyObject_DeliveryTemplate .......................................................................................................... 106

DeliveryTemplate_GetBurstsUsing ....................................................................................................... 106



DeliveryTemplate_GetNextBurstsUsing ............................................................................................... 106

Working with Burst Objects ...................................................................................................................... 107

CreateObject_Burst .............................................................................................................................. 108

GetObject_Burst ................................................................................................................................... 108

ModifyObject_Burst .............................................................................................................................. 109

Burst_SetEnabled .................................................................................................................................. 109

Burst_AddDocument ............................................................................................................................ 110

Burst_AddLiveDocument ...................................................................................................................... 111

Burst_GetDocumentID .......................................................................................................................... 112

Burst_SetDocumentProcessingMode ................................................................................................... 112

Burst_RemoveDocument ...................................................................................................................... 113

Burst_GetDocumentSummary .............................................................................................................. 113

Burst_SetDocumentOptions ................................................................................................................. 114

Burst_SetDocumentStatus .................................................................................................................... 114

Burst_SetDocumentDeliverIfEmpty ...................................................................................................... 115

Burst_SetDocumentRefreshEnabled .................................................................................................... 115

Burst_SetDocumentMaxGeneration .................................................................................................... 116

Burst_SetDocumentEmailSubject ......................................................................................................... 116

Burst_SetDocumentSource ................................................................................................................... 117

Burst_SetDocumentParameter ............................................................................................................. 118

Burst_SetDocumentParameterSource .................................................................................................. 119

Burst_AddDocumentFilter .................................................................................................................... 120

Burst_RemoveDocumentFilter ............................................................................................................. 120

Burst_SetDocumentFilter ..................................................................................................................... 121

Burst_SetDocumentFilterSource .......................................................................................................... 122

Burst_AddDocumentDelivery ............................................................................................................... 123

Burst_AddDocumentDeliveryWithTemplate ........................................................................................ 123

Burst_ModifyDocumentDelivery .......................................................................................................... 124

Burst_SetDocumentDeliveryEnabled .................................................................................................... 124

Burst_RemoveDocumentDelivery......................................................................................................... 125

Burst_AddStartAction ........................................................................................................................... 125



Burst_RemoveStartAction .................................................................................................................... 125

Burst_AddCompleteAction ................................................................................................................... 126

Burst_RemoveCompleteAction............................................................................................................. 126

Burst_AddAbortAction .......................................................................................................................... 126

Burst_RemoveAbortAction ................................................................................................................... 127

Burst_Execute ....................................................................................................................................... 127

Burst_Unlock ......................................................................................................................................... 127

Burst_GetRTSSummaryDateRange ....................................................................................................... 128

Burst_GetNextRTSSummaryDateRange ............................................................................................... 128

Burst_SetAlertMode ............................................................................................................................. 129

Burst_GetAlertMode ............................................................................................................................. 129

Burst_AddToAlertList ............................................................................................................................ 130

Burst_RemoveFromAlertList ................................................................................................................. 130

Burst_GetAlertList ................................................................................................................................. 130

Burst_GetUsedPaths ............................................................................................................................. 131

Burst_SetDocumentSortOrder .............................................................................................................. 131

Burst_AddQuery ................................................................................................................................... 132

Burst_GetQueryID ................................................................................................................................. 132

Working with XmlDataCache Objects ....................................................................................................... 133

CreateObject_XmlDataCache ............................................................................................................... 133

CreateObject_XmlDataSource .............................................................................................................. 134

CreateObject_XmlDataQuery ............................................................................................................... 134

GetObject_XmlDataCache .................................................................................................................... 134

GetObject_XmlDataSource ................................................................................................................... 135

GetObject_XmlDataQuery .................................................................................................................... 135

XDC_GetDataSourceColumns ............................................................................................................... 135

ModifyObject_XmlDataCache ............................................................................................................... 136

ModifyObject_XmlDataSource ............................................................................................................. 136

ModifyObject_XmlDataQuery .............................................................................................................. 136

DeleteObject_XmlDataSource .............................................................................................................. 137

DeleteObject_XmlDataQuery ............................................................................................................... 137


10 © InfoSol Inc 2008-2012

XDC_SetSource ...................................................................................................................................... 138

XDC_SetParameter................................................................................................................................ 138

XDC_SetFilter ........................................................................................................................................ 139

XDC_RemoveFilter ................................................................................................................................ 139

XDC_SetMultiCacheKey ........................................................................................................................ 140

XDC_SetEnabled .................................................................................................................................... 141

XDC_SetAlertMode ............................................................................................................................... 141

XDC_GetAlertMode .............................................................................................................................. 142

XDC_AddToAlertList .............................................................................................................................. 142

XDC_RemoveFromAlertList ................................................................................................................... 142

XDC_GetAlertList ................................................................................................................................... 143

XDC_AddStartAction ............................................................................................................................. 143

XDC_RemoveStartAction ...................................................................................................................... 143

XDC_AddCompleteAction ..................................................................................................................... 144

XDC_RemoveCompleteAction .............................................................................................................. 144

XDC_AddAbortAction ............................................................................................................................ 144

XDC_RemoveAbortAction ..................................................................................................................... 145

XDC_GetDataSourceColumns ............................................................................................................... 145

XDC_AddCrosstabForDataSource ......................................................................................................... 145

XDC_ModifyCrosstabForDataSource .................................................................................................... 146

XDC_RemoveCrosstabForDataSource................................................................................................... 146

XDC_AddCrosstabForCacheQuery ........................................................................................................ 147

XDC_ModifyCrosstabForCacheQuery ................................................................................................... 147

XDC_RemoveCrosstabForCacheQuery ................................................................................................. 148

XDC_Execute ......................................................................................................................................... 149

XDC_Unlock ........................................................................................................................................... 149

XDC_GetRTSSummaryDateRange ......................................................................................................... 150

XDC_GetNextRTSSummaryDateRange ................................................................................................. 150

Working with Runtime Activity Logs ......................................................................................................... 151

RTS_GetSummary ................................................................................................................................. 151

RTS_GetActions ..................................................................................................................................... 151


11 © InfoSol Inc 2008-2012

RTS_GetNextActions ............................................................................................................................. 152

RTS_EmailLog ........................................................................................................................................ 152

Working with Schedule & Event Objects .................................................................................................. 153

CreateObject_Schedule ........................................................................................................................ 153

GetObject_Schedule ............................................................................................................................. 155

ModifyObject_Schedule........................................................................................................................ 155

Schedule_SetEnabled ............................................................................................................................ 155

Schedule_AddBurst ............................................................................................................................... 156

Schedule_RemoveBurst ........................................................................................................................ 156

CreateObject_Event .............................................................................................................................. 157

GetObject_Event ................................................................................................................................... 157

Event_TestIfSet ..................................................................................................................................... 158

Event_GetWaitingSchedules ................................................................................................................. 158

ModifyObject_Event ............................................................................................................................. 159

Schedule_AddEvent .............................................................................................................................. 159

Schedule_RemoveEvent ....................................................................................................................... 160

Schedule_AddStartAction ..................................................................................................................... 160

Schedule_RemoveStartAction .............................................................................................................. 160

Schedule_AddCompleteAction ............................................................................................................. 161

Schedule_RemoveCompleteAction ...................................................................................................... 161

Schedule_AddAbortAction .................................................................................................................... 161

Schedule_RemoveAbortAction ............................................................................................................. 162

Schedule_Execute ................................................................................................................................. 162

Schedule_GetAllPending ....................................................................................................................... 163

Schedule_GetAllRunning ...................................................................................................................... 163

Schedule_GetAllFinished ...................................................................................................................... 163

Schedule_GetFinished .......................................................................................................................... 164

Event_GetAllPending ............................................................................................................................ 164

Schedule_GetFuturePending ................................................................................................................ 164

Schedule_Hold ...................................................................................................................................... 165

Schedule_Release ................................................................................................................................. 165


12 © InfoSol Inc 2008-2012

Schedule_Force ..................................................................................................................................... 165

Schedule_Stop ...................................................................................................................................... 166

Schedule_ChangePriority ...................................................................................................................... 166

Schedule_GetItems ............................................................................................................................... 166

Schedule_GetEvents ............................................................................................................................. 167

Schedule_GetStartActions .................................................................................................................... 167

Schedule_GetCompleteActions ............................................................................................................ 167

Schedule_GetAbortActions ................................................................................................................... 168

Working with Action Objects .................................................................................................................... 169

CreateObject_Action ............................................................................................................................. 169

GetObject_Action ................................................................................................................................. 170

ModifyObject_Action ............................................................................................................................ 170

Working with Parameter Alias Lists .......................................................................................................... 171

RegisterParameterAlias ........................................................................................................................ 171

GetAllParameterAliasNames................................................................................................................. 172

GetAllParameterNames ........................................................................................................................ 172

GetParameterAlias ................................................................................................................................ 172

ModifyParameterAlias .......................................................................................................................... 173

DeleteParameterAlias ........................................................................................................................... 173

Working with Registered Network Paths .................................................................................................. 174

RegisterNetworkPath ............................................................................................................................ 174

ModifyNetworkPath ............................................................................................................................. 174

GetAllNetworkPaths ............................................................................................................................. 175

DeleteNetworkPath .............................................................................................................................. 175

FileSystem_GetRootFolders .................................................................................................................. 176

FileSystem_GetNextRootFolders .......................................................................................................... 176

FileSystem_GetSubFolders ................................................................................................................... 177

FileSystem_GetNextSubFolders ............................................................................................................ 177

FileSystem_GetFilesInFolder ................................................................................................................. 178

FileSystem_GetNextFilesInFolder ......................................................................................................... 178

Working with Registered Network Printers .............................................................................................. 179


13 © InfoSol Inc 2008-2012

GetInstalledPrinters .............................................................................................................................. 179

RegisterNetworkPrinter ........................................................................................................................ 179

GetAllNetworkPrinters .......................................................................................................................... 179

DeleteNetworkPrinter ........................................................................................................................... 180

Working with Object Meta Tags ............................................................................................................... 181

RegisterMetaTag ................................................................................................................................... 181

GetAllMetaTags ..................................................................................................................................... 181

DeleteMetaTag ..................................................................................................................................... 182

SetMetaTags ......................................................................................................................................... 182

Retrieving Generic Object Information ..................................................................................................... 183

SearchForObjects .................................................................................................................................. 183

GetNextSearchObjects .......................................................................................................................... 184

GetObjectsCreatedBy ............................................................................................................................ 185

GetNextObjectsCreatedBy .................................................................................................................... 185

GetObjectInfoByID ................................................................................................................................ 186

GetObjectInfoListByID ........................................................................................................................... 186

GetObjectInfoByTypeAndID .................................................................................................................. 186

GetObjectInfoByPath ............................................................................................................................ 187

GetObjectInfoByTypeAndPath .............................................................................................................. 187

GetObjectHistory .................................................................................................................................. 188

GetNextObjectHistory ........................................................................................................................... 188

GetObjectHistoryBetween .................................................................................................................... 189

GetNextObjectHistoryBetween ............................................................................................................ 189

GetObjectReferences ............................................................................................................................ 190

GetNextObjectReferences .................................................................................................................... 190

GetLinkedObjects .................................................................................................................................. 191

GetNextLinkedObjects .......................................................................................................................... 191

Object Management ................................................................................................................................. 192

CopyObject ............................................................................................................................................ 192

CopyObjects .......................................................................................................................................... 192

MoveObject .......................................................................................................................................... 193


14 © InfoSol Inc 2008-2012

MoveObjects ......................................................................................................................................... 193

DeleteObject ......................................................................................................................................... 194

DeleteObjects........................................................................................................................................ 194

RenameObject ...................................................................................................................................... 194

ChangeObjectOwner ............................................................................................................................. 195

System Requests ....................................................................................................................................... 196

GetAllSystemRequests .......................................................................................................................... 196

GetActiveSystemRequests .................................................................................................................... 196

GetWaitingSystemRequests.................................................................................................................. 196

GetRuntimeCtx ...................................................................................................................................... 197

GetSystemRequest ................................................................................................................................ 197

GetSystemRequestsForSchedule .......................................................................................................... 197

ChangeRequestPriority ......................................................................................................................... 198

System Logs ............................................................................................................................................... 199

ReadSystemAuditLog ............................................................................................................................ 199

ReadNextSystemAuditLog ..................................................................................................................... 199

ReadSystemDocumentLog .................................................................................................................... 200

ReadNextSystemDocumentLog ............................................................................................................ 200

ReadSystemDeliveryLog ........................................................................................................................ 201

ReadNextSystemDeliveryLog ................................................................................................................ 201

System Configuration ................................................................................................................................ 202

GetAllConfigItems ................................................................................................................................. 203

GetConfigItem ....................................................................................................................................... 203

SetConfigItem ....................................................................................................................................... 203

Other functions ......................................................................................................................................... 204

LookupPlatformID ................................................................................................................................. 204

LookupUserID ........................................................................................................................................ 204

LookupGroupID ..................................................................................................................................... 204

LookupFolderID ..................................................................................................................................... 205

LookupObjectID .................................................................................................................................... 205

Objects ...................................................................................................................................................... 206


15 © InfoSol Inc 2008-2012

IB_ACL ................................................................................................................................................... 206

IB_Action ............................................................................................................................................... 206

IB_ActionRecipient ................................................................................................................................ 206

IB_AppSetting ....................................................................................................................................... 206

IB_Burst ................................................................................................................................................. 207

IB_BurstAction ...................................................................................................................................... 208

IB_BurstAlert ......................................................................................................................................... 208

IB_BurstDelivery ................................................................................................................................... 208

IB_BurstDeliveryCondition .................................................................................................................... 210

IB_BurstDeliveryExtension .................................................................................................................... 210

IB_BurstRecipient .................................................................................................................................. 210

IB_BurstDocument ................................................................................................................................ 210

IB_BurstDocumentOptions ................................................................................................................... 211

IB_BurstParameter ................................................................................................................................ 211

IB_ConfigItem ....................................................................................................................................... 211

IB_DataSource ....................................................................................................................................... 211

IB_DBConnection .................................................................................................................................. 212

IB_DBTable ............................................................................................................................................ 212

IB_DBTableSchema ............................................................................................................................... 212

IB_DBQry ............................................................................................................................................... 212

IB_DBQryParam .................................................................................................................................... 212

IB_DBQryColumn .................................................................................................................................. 212

IB_DBQryResult ..................................................................................................................................... 213

IB_DBQryRow ........................................................................................................................................ 213

IB_Document ........................................................................................................................................ 214

IB_DocumentLogon .............................................................................................................................. 215

IB_DocumentParam .............................................................................................................................. 215

IB_DocumentPreviewTab ..................................................................................................................... 215

IB_DocumentZipFile .............................................................................................................................. 215

IB_Event ................................................................................................................................................ 215

IB_FileList .............................................................................................................................................. 216


16 © InfoSol Inc 2008-2012

IB_FinishedSchedule ............................................................................................................................. 216

IB_FinishedScheduleItem ...................................................................................................................... 216

IB_Folder ............................................................................................................................................... 216

IB_Group ............................................................................................................................................... 216

IB_GroupResult ..................................................................................................................................... 217

IB_GroupUser ........................................................................................................................................ 217

IB_List .................................................................................................................................................... 217

IB_LdapAttr ........................................................................................................................................... 217

IB_LdapConnection ............................................................................................................................... 217

IB_LdapList ............................................................................................................................................ 217

IB_LdapResult ....................................................................................................................................... 218

IB_ListColumn ....................................................................................................................................... 218

IB_ListRow ............................................................................................................................................. 218

IB_MetaTag ........................................................................................................................................... 218

IB_MultiColumnList ............................................................................................................................... 218

IB_NetworkPath .................................................................................................................................... 218

IB_Object ............................................................................................................................................... 218

IB_ObjectResult..................................................................................................................................... 219

IB_ObjectHistory ................................................................................................................................... 219

IB_PendingEvent ................................................................................................................................... 219

IB_PendingEventInfo ............................................................................................................................. 219

IB_PendingSchedule ............................................................................................................................. 220

IB_PendingScheduleEvent .................................................................................................................... 220

IB_PI_Category ...................................................................................................................................... 220

IB_PI_CategoryResult ............................................................................................................................ 220

IB_PI_Document ................................................................................................................................... 220

IB_PI_DocumentResult ......................................................................................................................... 220

IB_PI_ExportedFile ................................................................................................................................ 221

IB_PI_ExportOptions ............................................................................................................................. 221

IB_PI_Folder .......................................................................................................................................... 221

IB_PI_FolderResult ................................................................................................................................ 221


17 © InfoSol Inc 2008-2012

IB_PI_Group .......................................................................................................................................... 221

IB_PI_GroupResult ................................................................................................................................ 221

IB_PI_InfoObject ................................................................................................................................... 221

IB_PI_InfoObjectResult ......................................................................................................................... 222

IB_PI_LOV .............................................................................................................................................. 222

IB_PI_Property ...................................................................................................................................... 222

IB_PI_ReportPart .................................................................................................................................. 222

IB_PI_User ............................................................................................................................................. 222

IB_PI_UserResult ................................................................................................................................... 222

IB_Platform ........................................................................................................................................... 222

IB_PlatformQueue ................................................................................................................................ 223

IB_RTSLog .............................................................................................................................................. 223

IB_RTSLogResult .................................................................................................................................... 223

IB_RTSLogObject ................................................................................................................................... 223

IB_RTSAction ......................................................................................................................................... 224

IB_RTSActionResult ............................................................................................................................... 224

IB_RTSCtx .............................................................................................................................................. 224

IB_RTSCtxItem ....................................................................................................................................... 224

IB_RunningSchedule ............................................................................................................................. 224

IB_RunningScheduleItem ...................................................................................................................... 225

IB_Schedule ........................................................................................................................................... 226

IB_ScheduleAction ................................................................................................................................ 226

IB_ScheduleItem ................................................................................................................................... 227

IB_ScheduleEvent ................................................................................................................................. 227

IB_SysActivity ........................................................................................................................................ 227

IB_SysAudit ........................................................................................................................................... 227

IB_SysAuditResult ................................................................................................................................. 227

IB_SysDeliver ......................................................................................................................................... 227

IB_SysDeliverResult ............................................................................................................................... 228

IB_SysDocument ................................................................................................................................... 228

IB_SysDocumentResult ......................................................................................................................... 229


18 © InfoSol Inc 2008-2012

IB_SysRequest ....................................................................................................................................... 229

IB_TemplateDelivery ............................................................................................................................. 230

IB_TemplateDeliveryCondition ............................................................................................................. 231

IB_TemplateDeliveryExtension ............................................................................................................. 231

IB_TemplateRecipient ........................................................................................................................... 231

IB_Text .................................................................................................................................................. 232

IB_Token ............................................................................................................................................... 232

IB_User .................................................................................................................................................. 232

IB_UserAppSetting ................................................................................................................................ 232

IB_UserCache ........................................................................................................................................ 232

IB_UserCacheResult .............................................................................................................................. 233

IB_UserDBLogon ................................................................................................................................... 234

IB_UserLogon ........................................................................................................................................ 234

IB_UserResult ........................................................................................................................................ 234

IB_XIList ................................................................................................................................................. 235

IB_XmlDataCache .................................................................................................................................. 235

IB_XmlDataCacheSource ....................................................................................................................... 236

IB_XmlDataCacheCrossTab ................................................................................................................... 236

IB_XmlDataCacheSize ........................................................................................................................... 237

IB_XmlDataCacheQuery ........................................................................................................................ 237

IB_XmlDataCacheParameter ................................................................................................................. 237

IB_XmlDataCacheFilter ......................................................................................................................... 237

IB_XDCAction ........................................................................................................................................ 237

IB_XDCAlert ........................................................................................................................................... 237

IB_XDCQryColumn ................................................................................................................................ 237

Enumerations ............................................................................................................................................ 238

AccessRight ........................................................................................................................................... 238

AlertMode ............................................................................................................................................. 238

BurstDestination ................................................................................................................................... 238

BurstDocumentStatus ........................................................................................................................... 238

BurstFormat .......................................................................................................................................... 238


19 © InfoSol Inc 2008-2012

BurstGroup ............................................................................................................................................ 239

BurstRecipientSendType ....................................................................................................................... 239

DataSource ............................................................................................................................................ 239

DbTableType ......................................................................................................................................... 239

DocumentParamType ........................................................................................................................... 239

DocumentProcessingMode ................................................................................................................... 239

DocumentStatus ................................................................................................................................... 239

EventCheckEvery ................................................................................................................................... 240

EventResetWhen................................................................................................................................... 240

IB_PI_ExportFormat .............................................................................................................................. 240

JobStatus ............................................................................................................................................... 240

LdapSearchScope .................................................................................................................................. 240

ListColumnType ..................................................................................................................................... 240

ObjectSubType ...................................................................................................................................... 241

ObjectType ............................................................................................................................................ 242

PlatformAuthType ................................................................................................................................. 243

PlatformAppServerTechnology ............................................................................................................. 243

PlatformConnectionType ...................................................................................................................... 243

PI_ParamType ....................................................................................................................................... 243

RecipientType ....................................................................................................................................... 243

RTSGenerationMode ............................................................................................................................. 243

RTSDeliveryMode .................................................................................................................................. 243

ScheduleFrequency ............................................................................................................................... 244

SystemRequestType .............................................................................................................................. 244

SystemRequestQueue ........................................................................................................................... 244

UserCacheContent ................................................................................................................................ 245

UserPassThru ........................................................................................................................................ 245

UserRole ................................................................................................................................................ 245

XcelsiusErrorMode ................................................................................................................................ 245

XDCAuthType ........................................................................................................................................ 245

XDCType ................................................................................................................................................ 245


20 © InfoSol Inc 2008-2012

XDSColumnTotals .................................................................................................................................. 245

XDSNumberFormat ............................................................................................................................... 245

XDSRowTotals ....................................................................................................................................... 246

XDSTotalType ........................................................................................................................................ 246


21 © InfoSol Inc 2008-2012

Introduction

This API allows you to integrate aspects of report distribution and/or management of InfoBurst objects

into your own application.

The API is separated into the following logical groups:

Service & System Information

Token Management

System Management (Platforms, Users and Groups)

Folder Management

Interfacing with a Document Platform

Cataloging Documents

Creating Parameter Aliases

Registering Network Paths and Printers

Creating new Objects

Retrieving Objects

Copying Objects

Moving Objects

Deleting Objects

Object History

Monitoring System Requests

Reading System Logs (Audit, Document and Delivery)

General usage notes – Date parameters

When passing a date value to a service function, be sure to encode the date value as UTC (Universal

Time) format so that local time zone information is available.

In most cases i