Web サービスのナレッジ添付メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービスのナレッジ添付メソッドについて説明します。
createAttmnt
createAttmnt メソッドでは、以下のパラメータを使用します。
パラメータ
データ タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
repositoryHandle
文字列
ドキュメント リポジトリのオブジェクト ハンドルを指定します。
folderId
整数
フォルダ ハンドル ID を指定します。
objectHandle
Int
この添付オブジェクトが添付されるナレッジ ドキュメントのオブジェクト ハンドルを指定します。
description
文字列
添付オブジェクトの説明を指定します。
fileName
文字列
アップロードするファイルの完全パス名を指定します。
説明
バックエンド サーバにファイルをアップロードします。 アップロードされたファイルは、repositoryHandleで指定したドキュメント リポジトリに保存されます。 添付オブジェクトが作成され、objectHandle で指定したドキュメント オブジェクトに添付されます。 添付オブジェクトには、リポジトリに新規アップロードされたファイルへのアクセス情報がすべて格納されています。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
<Handle>
文字列
新しく作成された添付オブジェクトのオブジェクト ハンドルを示します。
attmntFolderLinkCount
attmntFolderLinkCount メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
folderId
整数
フォルダの一意の ID を指定します。
説明
添付される特定のフォルダ内にある、添付ファイルのリンクの数が説明されます。
戻り値
特定のフォルダ内で検出された添付ファイルの数が返されます。
attachURLLink メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
ナレッジ ドキュメントの固有IDを指定します。
URL
文字列
ナレッジ ドキュメントに添付する URL を指定します。
attmntName
文字列
添付ファイルの名前を示します。
説明
文字列
添付ファイルの説明を指定します。
説明
ナレッジ ドキュメントに URL リンクを添付します。
戻り値
エラーのエラー コードのみを返します。 詳細については、「エラー コード」を参照してください。
getKDListPerAttmnt
getKDListPerAttmnt メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
attmntId
整数
添付ファイルの固有IDを示します。
説明
指定した添付ファイルに関連するナレッジ ドキュメントのリストが返されます。
戻り値
<UDSObject> ノード。ノードには、以下の <Attributes> 子ノードを使用してナレッジ ドキュメントを説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
id
整数
ナレッジ ドキュメントの固有IDを指定します。
getAttmntListPerKD
getAttmntListPerKD メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
ナレッジ ドキュメントの固有IDを指定します。
説明
指定したナレッジ ドキュメントに関連する添付ファイルのリストが返されます。
戻り値
<UDSObject> ノード。ノードには、以下の <Attributes> 子ノードで添付ファイルを説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
id
整数
添付ファイルの一意の ID を示します。
isAttmntLinkedKD
AttmntLinkedKD メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
attmntId
整数
添付ファイルの固有IDを示します。
説明
添付ファイルがナレッジ ドキュメントにリンクされているかどうかを確認します。見つかったリンクの数が返されます。
戻り値
見つかったリンクの数。
createFolder
getFolderList メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
parentFolderId
整数
親フォルダの一意の ID を指定します(親フォルダがない場合は 0)。
repId
整数
リポジトリの固有IDを示します。
folderType
整数
作成するフォルダのタイプを指定します。
description
文字列
フォルダの説明を示します。
folderName
文字列
フォルダ名を示します。
説明
添付ファイル ライブラリ経由でアクセスされるサービス デスク リポジトリにフォルダを新規に作成します。
注:
0 以外のフォルダ タイプは非表示のフォルダであり、[管理]タブの添付ファイル ライブラリにナビゲートすることによってのみ表示できます。 このようなフォルダはアップロード時に自動的に作成されるものであり、ユーザや Web サービスが作成してはいけません。フォルダ内のファイルがプライベートなものとなり、ほかのナレッジ ドキュメント、QA、またはナレッジ ファイルと共有できないためです。
戻り値
作成されたフォルダを説明する <UDSObject>。ノードには、以下の <Attributes> 子ノードの一部が含まれています。
XML エレメントの値
タイプ
説明
repository
SREL
リポジトリ名を示します。
parent_id
SREL
親フォルダの固有IDを示します。
folder_type
整数
作成されたフォルダのタイプを示します。
folder_name
文字列
フォルダ名を示します。
description
文字列
フォルダの説明を示します。
getFolderList
getFolderList メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
parentFolderId
整数
親フォルダの一意の ID を指定します(親フォルダがない場合は 0)。
repId
整数
リポジトリの固有IDを示します。
説明
指定した親フォルダにあるフォルダのリストが返されます。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードの一部を使用して添付フォルダを説明する 0 個以上の <UDSObject> が含まれています。
XML エレメントの値
タイプ
説明
repository
SREL
リポジトリ名を示します。
parent_id
SREL
親フォルダの固有IDを示します。
folder_type
整数
作成されたフォルダのタイプを示します。
folder_name
文字列
フォルダ名を示します。
description
文字列
フォルダの説明を示します。
getFolderInfo
getFolderInfo メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
folderId
整数
添付フォルダの固有IDを示します。
説明
フォルダの属性が返されます。
戻り値
<UDSObject> ノード。以下の <Attributes> 子ノードの一部を使用して添付フォルダを説明します。
XML エレメントの値
タイプ
説明
repository
SREL
リポジトリ名を示します。
parent_id
SREL
添付フォルダの親の固有IDを示します。
folder_type
整数
添付フォルダのタイプを示します。
folder_name
文字列
添付フォルダの名前を示します。
description
文字列
添付フォルダの説明を示します。
getAttmntList
getAttmntList メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
folderId
整数
添付フォルダの固有IDを示します。
repId
整数
リポジトリの固有IDを示します。 このパラメータが必要なのは、フォルダ ID がルート フォルダを示す 0 の場合だけです。
説明
指定した添付ファイル フォルダにある添付ファイルのリストが返されます。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードの一部を使用して添付ファイルを説明する、0 個以上の <UDSObject> が含まれています。
XML エレメントの値
タイプ
説明
repository
SREL
リポジトリ名を示します。
parent_id
SREL
親フォルダの固有IDを示します。
folder_type
整数
作成されたフォルダのタイプを示します。
folder_name
文字列
フォルダ名を示します。
description
文字列
フォルダの説明を示します。
getAttmntInfo
getAttmntInfo メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
attmntId
整数
添付フォルダの固有IDを示します。
説明
添付ファイルの属性が返されます。
戻り値
<UDSObject> ノード。以下の <Attributes> 子ノードの一部を使用して添付ファイルを説明します。
XML エレメントの値
タイプ
説明
id
整数
添付ファイルの固有IDを示します。
description
文字列
添付ファイルの説明を示します。
attmnt_name
文字列
添付ファイルの名前を示します。
file_name
文字列
ファイルの名前を示します。
folder_id
整数
添付フォルダの固有IDを示します。
repository
SREL
リポジトリの固有IDを示します。
getRepositoryInfo
getRepositoryInfo メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
repositoryId
整数
リポジトリの固有IDを示します。
説明
リポジトリの属性が返されます。
戻り値
リポジトリを説明する <UDSObject>。ノードには、以下の <Attributes> 子ノードの一部が含まれています。
XML エレメントの値
タイプ
説明
repository
SREL
リポジトリ名を示します。
parent_id
SREL
添付フォルダの親の固有IDを示します。
folder_type
整数
添付フォルダのタイプを示します。
folder_name
文字列
添付フォルダの名前を示します。
description
文字列
添付フォルダの説明を示します。