上一主题: IN 子句下一主题: XML 对象返回


Web 服务方法

此部分提供了使用 Web 服务方法的详细信息。每种方法均介绍了参数、描述和返回。

重要信息! 有关 Web 服务的其他信息,请参阅“实施指南”。

此部分包含以下主题:

Web 服务方法摘要

XML 对象返回

联系人管理方法

组管理方法

业务方法

Asset Management 方法

列表/查询方法

LREL 方法

知识管理

杂项方法

工作流方法

附件方法

REST HTTP 方法

Web 服务方法摘要

下表提供产品中 Web 服务方法的摘要:

方法名称(输入参数)

返回类型 [XML 根元素]

输出参数(类型:StringHolder)[XML 根元素]

说明

addAssetLog

(int sid, String assetHandle, String contactHandle, String logText)

void

 

为资产添加新日志条目。

addBookmark

(int sid, String contactId, int docId)

字符串

[UDSObject]

 

将书签添加到知识文档。

addComment

(int sid, String comment, int docId, String email, String username, String contactId)

字符串

[UDSObject]

 

向知识文档添加注释。

addMemberToGroup

(int sid, String contactHandle, String groupHandle)

void

 

将联系人添加至组。

attachChangeToRequest

(int sid, String creator, String requestHandle, String changeHandle, ArrayOfString changeAttrVals, String description)

字符串

 

将新变更单或现有变更单附加至请求。

attachURLLink

(int sid, int docId, String url, String attmntName, String description)

int

 

将 URL 链接附加至知识文档。

attmntFolderLinkCount

(int sid, int folderId)

int

 

返回文件夹的附加链接数。

callServerMethod

(int sid, String methodName, String factoryName, String formatList, ArrayOfString parameters)

字符串

[ServerReturn]

 

调用任意服务器端的方法。

changeStatus

(int sid, String creator, String objectHandle, String description, String newStatusHandle)

字符串

[UDSObject

(仅句柄)]

 

对故障单执行更新状态活动。

clearNotification

(int sid, String lrObject, String clearBy)

int

 

清除通知消息。

closeTicket

(int sid, String description, String ticketHandle)

字符串

[UDSObject

(仅句柄)]

 

将故障单的状态设置为“已关闭”。

createActivityLog

(int sid, String creator, String objectHandle, String description, String logType, int timeSpent, boolean internal)

字符串

[UDSObject

(仅句柄)]

 

为故障单创建活动日志条目。

createAsset

(int sid, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createAssetResult, StringHolder newAssetHandle, StringHolder newExtensionHandle, StringHolder newExtensionName)

void

createAssetResult

[UDSObject]

newAssetHandle

newExtensionHandle

newExtensionName

创建配置项(资产)。

createAssetParentChildRelationship

(int sid, String parentHandle, String childHandle)

字符串

 

创建资产主从关联关系。

createAttachment

(int sid, String repositoryHandle, String objectHandle, String description, String fileName)

字符串

 

将文件上传至后端服务器,并将其附加到故障单。

createAttmnt

(int sid, String repositoryHandle, int folderId, int objectHandle, String description, String fileName)

字符串

 

将文件上传至后端服务器,并将其附加到知识文档。

createChangeOrder

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newChangeHandle, StringHolder newChangeNumber)

字符串

[UDSObject]

newChangeHandle

newChangeNumber

创建变更单故障单。

createDocument

(int sid, ArrayOfString kdAttributes)

字符串

[UDSObjectList]

 

创建知识文档。

createFolder

(int sid, int parentFolderId, int repId, int folderType, String description, String folderName)

字符串

[UDSObject]

 

在附件存储库中创建文件夹。

createIssue

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newIssueHandle, StringHolder newIssueNumber)

 

字符串

[UDSObject]

newIssueHandle

newIssueNumber

创建投诉故障单。

createLrelRelationships

(int sid, String contextObject, String lrelName, ArrayOfString addObjectHandles)

void

 

添加一个或多个多对多关系。

createObject

(int sid, String objectType, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createObjectResult, StringHolder newHandle)

void

createObjectResult

[UDSObject]

newHandle

创建 CA SDM 对象。

createQuickTicket

(int sid, String customerHandle, String description, StringHolder newTicketHandle, StringHolder newTicketNumber)

字符串

[UDSObject]

newTicketHandle

newTicketNumber

基于指定最终用户的首选文档类型创建故障单。

createRequest

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newRequestHandle, StringHolder newRequestNumber)

字符串

[UDSObject]

newRequestHandle

newRequestNumber

 

创建请求故障单。

createTicket

(int sid, String description, String problem_type, String userid, String asset, String duplication_id, StringHolder newTicketHandle, StringHolder newTicketNumber, StringHolder returnUserData, StringHolder returnApplicationData)

字符串

[UDSObject(空)]

newTicketHandle

newTicketNumber

returnUserData

returnApplicationData

根据服务意识策略和指定问题类型中定义的规则创建故障单。

createWorkFlowTask

(int sid, ArrayOfString attrVals, String objectHandle, String creatorHandle, String selectedWorkFlow, String taskType, ArrayOfString attributes, StringHolder createWorkFlowTaskResult, StringHolder newHandle)

void

createWorkFlowTaskResult

[UDSObject]

newHandle

创建工作流任务。

deleteBookmark

(int sid, String contactId, int docId)

int

 

从知识文档中删除书签。

deleteComment

(int sid, int commentId)

int

 

删除知识文档的注释。

deleteDocument

(int sid, int docId)

int

 

将知识文档标记为待删除。

deleteWorkFlowTask

(int sid, String workFlowHandle, String objectHandle)

void

 

从工作流任务关联的故障单中删除该任务。

detachChangeFromRequest

(int sid, String creator, String requestHandle, String description)

字符串

 

从请求中分离变更单。

doQuery

(int sid, String objectType, String whereClause)

ListResult

[listHandle, listLength]

 

对指定的对象类型执行 SQL-like 选择。

doSelect

(int sid, String objectType, String whereClause, int maxRows, ArrayOfString attributes)

字符串

[UDSObjectList]

 

对指定的对象类型执行 SQL-like 选择。

doSelectKD

(int sid, String whereClause, String sortBy, boolean desc, int maxRows, ArrayOfString attributes, int skip)

字符串

[UDSObjectList]

 

对知识文档对象执行 SQL-like 选择。

escalate

(int sid, String creator, String objectHandle, String description, boolean setAssignee, String newAssigneeHandle, boolean setGroup, String newGroupHandle, boolean setOrganization, String newOrganizationHandle, boolean setPriority, String newPriorityHandle)

字符串

[UDSObject

(仅句柄)]

 

对故障单执行升级活动。

faq

(int sid, String categoryIds, int resultSize, String propertyList, String sortBy, boolean descending, String whereClause, int maxDocIDs)

字符串

[UDSObjectList]

 

对知识文档执行 faq 搜索。

findContacts

(int sid, String userName, String lastName, String firstName, String email, String accessType, int inactiveFlag)

字符串

[UDSObjectList]

 

检索联系人列表。

freeListHandles

(int sid, ArrayOfInt handles)

void

 

将服务器端资源释放给列表,并使列表句柄无效。

getAccessTypeForContact

(int sid, String contactHandle)

字符串

 

返回联系人访问类型的句柄。

getArtifact

(int sid, String contact, String password)

字符串

 

返回要附加到 URL 的印证码。

getAssetExtensionInformation

(int sid, String assetHandle, ArrayOfString attributes, StringHolder getAssetExtInfoResult, StringHolder extensionHandle, StringHolder extensionName)

 

void

getAssetExtInfoResult

[UDSObject]

extensionHandle

extensionName

返回资产的扩展信息。

getAttmntInfo

(int sid, int attmntId)

字符串

[UDSObjectList]

 

返回附件的属性。

getAttmntList

(int sid, int folderId, int repId)

字符串

[UDSObjectList]

 

返回给定附件文件夹下的附件列表。

getAttmntListPerKD

(int sid, int docId)

字符串

[UDSObjectList]

 

返回指定知识文档的附件列表。

getBookmarks

(int sid, String contactId)

字符串

[UDSObjectList]

 

检索指定联系人的书签。

getBopsid

(int sid, String contact)

字符串

 

返回要附加到 URL 的令牌。

getCategory

(int sid, int catId, boolean getCategoryPaths)

字符串

[UDSObjectList]

 

检索知识类别的信息。

getComments

(int sid, String docIds)

字符串

[UDSObjectList]

 

检索知识文档列表的所有注释。

getConfigurationMode

(int sid)

字符串

 

返回 CA SDM 是否正在以 ITIL 模式运行的确认结果。

getContact

(int sid, String contactId)

字符串

[UDSObject]

 

检索指定联系人的信息。

getDecisionTrees

(int sid, String propertyList, String sortBy, boolean descending)

字符串

[UDSObjectList]

 

检索所有决策树知识文档。

getDependentAttrControls

(int sid, String handle, ArrayOfString attrVals)

字符串

[UDSObjectList]

 

返回状态对象的锁定属性和必要属性列表。

getDocument

(int sid, int docId, String propertyList, boolean relatedDoc, boolean getAttmnt, boolean getHistory, boolean getComment, boolean getNotiList)

字符串

[UDSObject]

 

检索知识文档的信息。

getDocumentsByIDs

(int sid, String docIds, String propertyList, String sortBy, boolean descending)

字符串

[UDSObjectList]

 

检索一个或多个知识文档的信息。

getDocumentTypes

(int sid)

字符串

[UDSObjectList]

 

返回所有知识文档类型列表。

getFolderInfo

(int sid, int folderId)

字符串

[UDSObject]

 

 

检索指定附件文件夹的信息。

getFolderList

(int sid, int parentFolderId, int repId)

字符串

[UDSObjectList]

 

返回指定主文件夹下的文件夹列表。

getGroupMemberListValues

(int sid, String whereClause, int numToFetch, ArrayOfString attributes)

字符串

[UDSObjectList]

 

查询系统和成员关联关系小组。

getHandleForUserid

(int sid, String userID)

字符串

 

返回联系人的持久句柄。

getKDListPerAttmnt

(int sid, int attmntId)

字符串

[UDSObjectList]

 

返回知识文档列表以及对指定附件的引用。

getListValues

(int sid, int listHandle, int startIndex, int endIndex, ArrayOfString attributeNames)

字符串

[UDSObjectList]

 

返回列表中某个范围对象的属性值。

getLrelLength()

(int sid, String contextObject, String lrelName)

int

 

返回多对多关联关系某一方的对象数。

getLrelValues

(int sid, String contextObject, String lrelName, int startIndex, int endIndex, ArrayOfString attributes)

字符串

[UDSObjectList]

 

返回多对多关联关系中某个范围对象的属性值。

getNotificationsForContact

(int sid, String contactHandle, int queryStatus)

ListResult

[listHandle, listLength]

 

返回指定联系人的通知(lr 对象)句柄列表。

getObjectTypeInformation

(int sid, String factory)

字符串

[UDSObject(特别)]

 

返回指定对象的所有属性名称列表。

getObjectValues

(int sid, String objectHandle, ArrayOfString attributes)

字符串

[UDSObject]

 

返回指定对象句柄的属性值。

getPendingChangeTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

返回分配给指定联系人的所有未决变更单工作流任务。

getPendingIssueTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

返回分配给联系人的所有未决投诉工作流任务。

getPermissionGroups

(int sid, int groupId)

字符串

[UDSObjectList]

 

检索权限组信息。

getPolicyInfo

(int sid)

字符串

[SAPolicy]

 

返回当前会话的访问策略信息。

getPriorities

(int sid)

字符串

[UDSObjectList]

 

检索所有知识优先级。

getPropertyInfoForCategory

(int sid, String categoryHandle, ArrayOfString attributes)

字符串

[UDSObjectList]

 

检索指定类别的属性信息。

getQuestionsAsked

(int sid, int resultSize, boolean descending)

字符串

[UDSObjectList]

 

检索历史知识文档搜索文本。

getRelatedList

(int sid, String objectHandle, String listName)

ListResult

[listHandle, listLength]

 

返回对象列表(QREL 或 BREL)的列表句柄。

getRelatedListValues

(int sid, String objectHandle, String listName, int numToFetch, ArrayOfString attributes, StringHolder getRelatedListValuesResult, IntHolder numRowsFound)

void

getRelatedListValuesResult

[UDSObjectList]

numRowsFound

(IntHolder)

返回对象列表的值。

getRepositoryInfo

(int sid, int repositoryId)

字符串

[UDSObject]

 

返回存储库信息。

getStatuses

(int sid)

字符串

[UDSObjectList]

 

检索所有知识状态。

getTaskListValues

(int sid, String objectHandle, ArrayOfString attributes)

字符串

[UDSObjectList]

 

返回与指定投诉或变更单关联的任务的值。

getTemplateList

(int sid)

字符串

[UDSObjectList]

 

检索所有文档模板。

getValidTaskTransitions

(int sid, String taskHandle, ArrayOfString attributes)

字符串

[UDSObjectList]

 

返回特定任务所有可能的状态转变。

返回特定任务所有可能的状态转变。

字符串

[UDSObjectList]

 

返回特定故障单所有可能的状态转变。

getWorkflowTemplateList

(int sid)

字符串

[UDSObjectList]

 

检索所有知识工作流模板。

getWorkFlowTemplates

(int sid, String objectHandle, ArrayOfString attributes)

字符串

[UDSObjectList]

 

返回与变更单或投诉类别关联的所有工作流模板。

impersonate

(int sid, String userid)

int

 

为新用户作废旧的会话,并返回新的会话 ID。

isAttmntLinkedKD

(int sid, int attmntId)

int

 

返回所有知识文档的附件链接数。

logComment

(int sid, String ticketHandle, String comment, int internalFlag)

void

 

对故障单执行记录注释活动。

login

(String username, String password)

int

 

验证用户并返回唯一会话 ID。

loginService

(String username, String password, String policy)

int

 

验证用户并返回唯一会话 ID。

loginServiceManaged

(String policy, String encrypted_policy)

字符串

 

针对 PKI 配置执行用户身份验证,并返回会话 ID。

loginWithArtifact

(String userid, String artifact)

int

 

使用印证码验证用户,并返回唯一会话 ID。

注销

(int sid)

void

 

作废并释放会话 ID。

modifyDocument

(int sid, int docId, ArrayOfString kdAttributes)

字符串

[UDSObject]

 

更新知识文档。

notifyContacts

(int sid, String creator, String contextObject, String messageTitle, String messageBody, int notifyLevel, ArrayOfString notifyees, boolean internal)

字符串

[UDSObject(仅句柄)]

 

将通知发送至一个或多个联系人。

rateDocument

(int sid, int docId, int rating, int multiplier, String ticketPerId, boolean onTicketAccept, boolean solveUserProblem, boolean isDefault)

字符串

[UDSObjectList]

 

对特定知识文档进行评级。

removeAttachment

(int sid, String attHandle)

int

 

从故障单中删除附件。

removeLrelRelationships

(int sid, String contextObject, String lrelName, ArrayOfString removeObjectHandles)

void

 

删除一个或多个多对多关联关系。

removeMemberFromGroup

(int sid, String contactHandle, String groupHandle)

void

 

将联系人从组中删除。

搜索

(int sid, String problem, int resultSize, String properties, String sortBy, boolean descending, boolean relatedCategories, int searchType, int matchType, int searchField, String categoryPath, String whereClause, int maxDocIDs)

字符串

[UDSObjectList(嵌套)]

 

搜索知识文档解决方案。

serverStatus

(int sid)

int

 

返回 CA SDM 服务器的状态(启动或关闭)。

transfer

(int sid, String creator, String objectHandle, String description, boolean setAssignee, String newAssigneeHandle, boolean setGroup, String newGroupHandle, boolean setOrganization, String newOrganizationHandle)

字符串

[UDSObject

(仅句柄)]

 

对故障单执行转移活动。

updateObject

(int sid, String objectHandle, ArrayOfString attrVals, ArrayOfString attributes)

字符串

[UDSObject]

 

更新指定对象的一个或多个属性。

updateRating

(int sid, int buId, int rate)

字符串

[UDSObject]

 

更新知识文档的现有评级。

loginWithArtifact

(String userid, String artifact)

int

 

使用印证码验证用户,并返回唯一会话 ID。

getArtifact

(int sid, String contact, String password)

字符串

 

返回要附加到 URL 的印证码。