Solutions Business Manager Web Services Developer's Guide Copyright © 2001–2019 Micro Focus or one of its affiliates. The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are as may be set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Except as specifically indicated otherwise, this document contains confidential information and a valid license is required for possession, use or copying. If this work is provided to the U.S. Government, consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed under vendor's standard commercial license. Part number: Product version: 11.7 Publication date: 2019-11-01 2 Solutions Business Manager (SBM) Table of Contents Chapter 1: Preface .......................................................................................... 13 Chapter 2: Getting Started ................................................................................. 15 About the SBM Application Engine Web Services API .......................................... 15 About Web Services ....................................................................................... 15 SOAP Requests ............................................................................................. 15 Before You Begin .......................................................................................... 16 Setting up the Development Environment......................................................... 17 Installing the SBM Web Services API ............................................................... 18 Web Service and Script Execution Order ......................................................... 19 Error Message Logs ....................................................................................... 20 SOAP Faults ................................................................................................ 20 Chapter 3: Web Services API Reference ............................................................... 23 SBM Application Web Services........................................................................... 23 Application Calls .......................................................................................... 23 CreateAuxItem .......................................................................................... 27 CreateAuxItems.......................................................................................... 29 CreateFileAttachment ................................................................................. 33 CreateNoteAttachment................................................................................. 34 CreatePrimaryItem .................................................................................... 36 CreatePrimaryItems .................................................................................... 40 DeleteAttachment ....................................................................................... 45 DeleteItems ............................................................................................. 47 DeleteItemsByQuery ................................................................................. 48 GetApplications .......................................................................................... 50 GetAvailableSubmitTransitions ..................................................................... 51 GetAvailableTransitions .............................................................................. 52 GetFieldSelections....................................................................................... 54 GetFileAttachment .................................................................................... 55 Web Services Developer's Guide 3 GetFileField ................................................................................................ 56 GetGroupMembers .................................................................................... 58 GetItem ................................................................................................... 59 GetItems ................................................................................................... 61 GetItemsByQuery ....................................................................................... 64 GetItemsChangeHistory .............................................................................. 67 GetNoteLoggerInfo .................................................................................... 68 GetReports ................................................................................................ 69 GetSolutions ............................................................................................. 72 GetStateChangeHistory .............................................................................. 73 GetSubmitProjects .................................................................................... 74 GetTables................................................................................................... 75 GetURLField ............................................................................................. 77 GetUsers ................................................................................................... 78 GetVersion ................................................................................................ 81 GetWorkflows ............................................................................................. 81 IsUserValid ................................................................................................ 83 LinkSubtask ............................................................................................. 84 Logout ...................................................................................................... 85 RunModScript ............................................................................................. 86 RunReport ................................................................................................ 87 RunReportXml .......................................................................................... 90 TransitionItem .......................................................................................... 92 TransitionItems .......................................................................................... 95 UpdateFileAttachment ................................................................................. 99 UpdateFileField ....................................................................................... 101 UpdateURLField ....................................................................................... 103 Common Types .......................................................................................... 106 ApplicationIdentifier ................................................................................. 109 4 Solutions Business Manager (SBM) Attachment-Access-Type ........................................................................... 110 Band-Orientation .................................................................................... 111 ContactIdentifier .................................................................................... 111 Field-Attribute ....................................................................................... 112 FieldIdentifier .......................................................................................... 113 FileObj-Action.......................................................................................... 114 FieldValue ............................................................................................. 115 FileAttachment ....................................................................................... 116 FileAttachmentContents ........................................................................ 117 FileBufferBase64 .................................................................................... 118 FileContents .......................................................................................... 118 GrantState ............................................................................................. 119 GroupIdentifier ....................................................................................... 119 GroupIdentifierEx .................................................................................... 120 Identifier ................................................................................................ 121 ItemIdentifier .......................................................................................... 122 ItemLink ................................................................................................ 123 ItemLink-Type ....................................................................................... 125 Note ...................................................................................................... 126 PrivilegeIdentifier .................................................................................... 127 PrivilegeKind .......................................................................................... 128 ProjectIdentifier......................................................................................