Webサービス メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービス メソッドの使用法について説明します。 メソッドごとに、パラメータ、説明、および戻り値を記述します。
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 パラメータ)
文字列
[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
1 つ以上の多対多の関係を追加します。
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 に似た選択操作が実行されます。
doSelect
(int sid、String objectType、String whereClause、int maxRows、ArrayOfString attributes)
文字列
[UDSObjectList]
指定したオブジェクト タイプに対して SQL に似た選択操作が実行されます。
doSelectKD
(int sid、String whereClause、String sortBy、boolean desc、int maxRows、ArrayOfString attributes、int skip)
文字列
[UDSObjectList]
指定したナレッジ ドキュメントに対して SQL に似た選択操作が実行されます。
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]
1 つ以上のナレッジ ドキュメントの情報を取得します。
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 を返します。
logout
(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 (ハンドルのみ)]
1 つ以上の連絡先に通知を送信します。
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
1 つ以上の多対多の関係を削除します。
removeMemberFromGroup
(int sid、String contactHandle、String groupHandle)
void
グループから連絡先を削除します。
search
(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、boolean setPriority、String newOrganizationHandle)
文字列
[UDSObject
(ハンドルのみ)]
チケットに対して転送アクティビティを実行します。
updateObject
(int sid、String objectHandle、ArrayOfString attrVals、ArrayOfString attributes)
文字列
[UDSObject]
指定したオブジェクトの 1 つ以上の属性を更新します。
updateRating
(int sid、int buId、int rate)
文字列
[UDSObject]
ナレッジ ドキュメントの既存の評価を更新します。
loginWithArtifact
(String userid、String artifact)
int
アーチファクトでユーザを認証し、一意のセッション ID を返します。
getArtifact
(int sid、String contact、String password)
文字列
URL に追加するアーチファクトを返します。
XMLオブジェクトの戻り値
多くの Web サービス メソッドは、CA SDM オブジェクトを XML 形式で返します。 Webサービスは、以下のルート エレメントで始まるXMLの標準構造を使用します。
<UDSObject>
XML形式は以下の表のとおりです。
XML エレメント
タイプ
説明
<UDSObject>
N/A
ルート ノードを示します。
<Handle>
文字列
オブジェクト ハンドルを示します。
<Attributes>
シーケンス
属性値を示します。 オブジェクト属性値のエレメントを0個以上保持します。
<
attrName0
DataType =
“typeEnum">
文字列
AttrName0
を示します。これは CA SDM の majic(.maj)ファイルまたは mod (.mod)ファイルで定義されたオブジェクトの属性名です。
使用するWebメソッドによってはドット表記が使えます。
エレメント値は属性値になります。 エレメントの値が空の場合、オブジェクト属性の値も空/Nullです。
DataType 属性には、CA SDM 環境内の属性のデータ タイプを示す整数が入ります。
getObjectValues()をコールした場合、以下のような情報が返されます。
<UDSObject> <Handle>cnt:555A043EDDB36D4F97524F2496B35E75</Handle> <Attributes> <Attribute DataType="2003"> <AttrName>first_name</AttrName> <AttrValue>first name</AttrValue> <DisplayValue>Yaakov</DisplayValue> </Attribute> <Attribute DataType="2005"> <AttrName>organization</AttrName> <AttrValue>342</AttrValue> <DisplayValue>Accounting Crew</DisplayValue> </Attribute> </Attributes> <Lists> <List name="mylist1"> <UDSObject>...</UDSObject> <UDSObject>...</UDSObject> </List> </Lists> </UDSObject>
doSelect()などのメソッドは、<UDSObjectList> エレメントに一連の <UDSObject> エレメントを含めて返します。
<Lists> セクションには0個以上の <List> ノードが含まれます。 <List> ノードには、0 個 以上の <UDSObject> が含まれています。 通常、 エレメントはリスト値に対する特定のリクエストが行われた場合にのみ返されます。
特定のオブジェクトに関連する値のリストを返す場合は、
getRelatedListValues
メソッドを使用する必要があります。
actlog などの属性名をリクエストせずに、リストのみリクエストした場合は、<UDSObject> 全体が <List> セクションに返されます。
ただし、getDocument() などの特殊なメソッドは除きます。 属性をリクエストすると、データベース値が返されます。 SREL属性の場合、この値はあまり役立ちません。 リクエストの assignee 属性をリクエストすると、Contact REL_ATTR (外部キー)が ID であるため、整数が返されます。 CA Service Desk Manager r11.0 では、属性の戻りデータに DBMS のエレメント、および SREL 参照の共通名の値が含まれます。