Web サービスのナレッジ管理

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
データベース構造を熟知していると、Web サービスのナレッジ管理を使用する際に役立ちます。
テーブル タイプ
特に重要なテーブルは以下のとおりです。
テーブル タイプ
説明
skeleton
ドキュメントに関するすべての情報を保存します。各行が 1 ドキュメントを表します。 PropertyList および SortBy パラメータを FAQ()、Search() などのメソッドに渡すときに、このテーブルのフィールド名を使用できます。 フィールド名は大文字と小文字を区別するので、データベースの表記どおりに渡すように注意してください。
o_indexes
カテゴリに関するすべての情報を保存します。各行が 1 カテゴリを表します
ナレッジ管理の汎用メソッド
このセクションでは、ナレッジ管理の汎用メソッドについて説明します。 ナレッジ ドキュメントの並べ替えに使用する有効なプロパティは以下のとおりです(使用できない場合もあります)。
  • RELEVANCE
  • AUTHOR_ID
  • BU_RESULT
  • CREATION_DATE
  • DOC_TYPE_ID
  • EXPIRATION_DATE
  • HITS
  • id
  • MODIFY_DATE
  • OWNER_ID
  • PRIORITY_ID
  • ACCEPTED_HITS
  • ASSET_ID
  • SD_ASSET_ID
  • ASSIGNEE_ID
  • PRODUCT_ID
  • START_DATE
  • STATUS_ID
  • SUBJECT_EXPERT_ID
faq
faqメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
categoryIds
文字列
faqの実行に使用するカテゴリIDを指定します。 「ルート」カテゴリには1を使用します。
注:
「1, 2, 3」のように複数の ID を指定できます。
resultSize
整数
詳細情報を取得するドキュメントの数を指定します。 残りのドキュメントについてはIDのみが返されます。 これらのドキュメントの詳細情報には、後からgetDocumentsByIDs()メソッドを使用してアクセスすることができます。 初期設定は10です。
propertyList
文字列
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
id
DOC_TYPE_ID
BU_RESULT
sortBy
文字列
結果の並べ替えに使用するデータベース フィールドを指定します。 複数の並べ替えフィールドを指定することはできません。 初期設定はBU_RESULTで、FAQ評価による並べ替えが実行されます。 指定したフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。 "SortBy"での[
ヒット数
]の値もサポートされます。 [
ヒット数
]では、ドキュメントが表示された回数を指定します。
descending
ブール値
結果を降順で並べ替えるかどうかを指定します。
whereClause
文字列
このパラメータを使用して、「SQLのWhere節」を追加し、検索結果をフィルタリングします。
maxDocIds
整数
返されるドキュメントIDの最大数を指定します(初期設定は100)。
たとえば、resultSizeに10、maxDocIdsに50を指定し、一致するドキュメントがデータベースに100個あった場合、そのうちの10個については詳細情報が取得され、40個についてはIDのみが返されます。 残りの50ドキュメントについては何も返されません。
説明
FAQ 検索の実行に使用します。 ドキュメントは、渡したカテゴリIDに基づいて取得されます。 そのカテゴリ、またはサブカテゴリにあるドキュメントが返されます。 パフォーマンスを向上するため、これらのメソッドはresultSizeパラメータで指定したユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについてはIDのみが返されます。 このメソッドを使用すると、たとえば、[先頭]、[戻る]、[次へ]、[最後]といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。 最大100個のIDが返されます。
戻り値
<UDSObjectList> ノード。ノード内に以下のセクションが返されます。
本章の ノードの説明セクションで説明されている ノード。 n が resultSize パラメータに指定した値に等しい場合、このメソッドで検出される最初の
n
個のドキュメントについて、<UDSObject> ノードとそのすべてのプロパティが返されます。
たとえば、resultSizeパラメータに10、maxDocIDsパラメータに50を指定し、メソッドが100個のドキュメントを見つけた場合、<Attributes> を持つ10個の <UDSObject> がpropertyListパラメータで指定した属性の詳細情報を含む最初の <UDSObject> セクションと共に返され、40個の <UDSObject> ノードが ID <Attributes> のみを含む後続のセクションと共に返されます。 11~20番目のドキュメントの 詳細 ID <AttrName> の情報を取得する場合は、getDocumentsByIDs()メソッドをコールして、<AttrValue> の ID を渡す必要があります。
searchメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
problem
文字列
解決策を検索する問題の説明を指定します。
resultSize
整数
詳細情報を取得するドキュメントの数を指定します。 残りのドキュメントについては、IDのみが返されます。 これらのドキュメントの詳細情報には、後からgetDocumentsByIDs()メソッドを使用してアクセスすることができます。 初期設定は10です。
propertyList
文字列
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
id
DOC_TYPE_ID
sortBy
文字列
結果の並べ替えに使用するデータベース フィールドを指定します。 複数の並べ替えフィールドを指定することはできません。 初期設定はRELEVANCEです。 指定したフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。 有効な並べ替えプロパティについては、「faqメソッド」を参照してください。
descending
ブール値
結果を降順で並べ替えるかどうかを指定します。
relatedCategories
ブール値
見つかったドキュメントのすべての関連カテゴリのリストを返すかどうかを指定します。
searchType"\y"searchType
整数
実行する検索のタイプを指定します。
1 = 自然言語検索(NLS)
2 = ナレッジ マネジメント検索
matchType
整数
一致タイプを指定します。
0 = ORタイプの一致
1 = ANDタイプの一致
2 = 完全一致
注:
searchType パラメータとして NLS が選択された場合は、OR と AND の matchType のみが有効です。
searchField
整数
検索を行うフィールドのバイナリ値の組み合わせを指定します。
タイトル = 1
概要 = 2
問題 = 4
解決策 = 8
たとえば、すべてのフィールドを検索する場合は、15(1+2+4+8)を指定します。 概要と問題のみを検索するには、6(2+4)を指定します。
注:
デフォルトでは問題が検索されます。
searchType パラメータを NLS に設定すると、searchFields パラメータは無視されます。NLS 検索では問題フィールドしか検索できないためです。
categoryPath
文字列
検索結果を特定のカテゴリに制限します。 カテゴリIDの完全パスを指定する必要があります。複数のカテゴリを指定する場合はカンマで区切ります。 たとえば、「1-3-5, 1-4-8」と指定すると、カテゴリ5および8(およびそのサブカテゴリ)に検索が制限されます。
whereClause
文字列
このパラメータを使用して、「SQLのWhere節」を追加し、検索結果をフィルタリングします。
maxDocIds
整数
返されるドキュメントIDの最大数を指定します。 たとえば、resultSizeに10、maxDocIdsに50を指定し、一致するドキュメントがデータベースに100個あった場合、そのうちの10個については詳細情報が取得され、40個についてはIDのみが返されます。 残りの50ドキュメントについては何も返されません。 初期設定は100です。
説明
問題の解決策を検索します。 ドキュメントは、渡した問題に基づいて取得されます。 問題の説明に一致、または類似するドキュメントが返されます。 パフォーマンスを向上するため、これらのメソッドはresultSizeパラメータで指定したユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについては ID のみが返されます。 このメソッドを使用すると、たとえば、[先頭]、[戻る]、[次へ]、[最後]といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。
戻り値
<UDSObjectList> ノード。ノード内に以下のセクションが返されます。
本章の ノードの説明セクションで説明されている ノード。
n
が resultSize パラメータに指定した値に等しい場合、このメソッドで検出される最初の
n
個のドキュメントについて、<UDSObject> ノードとそのすべてのプロパティが返されます。 たとえば、resultSize パラメータに 10、maxDocIDs パラメータに 50 を指定し、メソッドが 100 個のドキュメントを見つけた場合、10 個の <UDSObject> ノードがリクエストしたすべてのプロパティを含む <Attributes> セクションと共に返され、40 個の <UDSObject> が ID プロパティのみを含む <Attributes> セクションと共に返されます。 11~20番目のドキュメントの詳細な <UDSObject> 情報を取得する場合は、getDocumentsByIDs()メソッドをコールして、これらのIDを渡す必要があります。
getRelatedCategoriesパラメータをTrueに設定すると、関連カテゴリ用の <UDSObjectList> ノードが <Attributes> セクションに含まれます。 各 <INDEX_DOC_LINKS> ノードには、以下のようにカテゴリの関係付け ID が含まれます。
1-70
doSelectKD
doSelectKDメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
whereClause
文字列
(オプション)クエリのWhere節を指定します。
sortBy
文字列
結果の並べ替えに使用するデータベース フィールドを指定します。 複数の並べ替えフィールドを指定することはできません。 初期設定はBU_RESULTで、FAQ評価による並べ替えが実行されます。 指定したフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。
desc
ブール値
結果を降順で並べ替えるかどうかを指定します。 ドキュメントを降順で並べ替える場合は True を、昇順で並べ替える場合は False を使用します。
maxRows
整数
返される行の最大数を指定します。 -1を指定するとすべての行が返されます。
注:
指定した整数に関係なく、CA SDM では 1 コールにつき最大 250 行が返されます。
attributes
String[]
フェッチする値が入っている属性のリストを指定します。 ドット付きの属性を使用することができます。 このフィールドが空の場合は、値に基づく属性がすべて返されます。 これらの属性はmajic定義ファイルでLOCALと定義することはできません。 LOCAL属性は一時的で、データベースに保存されません。
skip
整数
先頭からスキップするナレッジ ドキュメントの数を指定します。 すべてのドキュメントを返す場合はゼロ(0)を指定します。
説明
ナレッジ ドキュメント テーブルに対してSQLに類似した選択操作が実行されます。 指定したWhere節に一致するオブジェクトから属性をフェッチして、必要な1つ以上の属性を返します。
戻り値
一連の <UDSObject> エレメント。 以下のフォーマットが適用されます。
<UDSObjectList> <UDSObject> <Handle> <Attributes> <AttributeName0> <AttributeName1>
XML エレメント
タイプ
説明
<UDSObject>
シーケンス
<Handle> エレメント、および一連の <Attributes> を含みます。
<UDSObjectList>
一連の<UDSObject>エレメントを含む外部エレメントを示します。
createDocument
createDocumentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
kdAttributes
String[]
新規ナレッジ ドキュメントの初期属性値の設定に使用される名前と値のペアの配列を以下のように指定します。
"SUMMARY","Summary text",
"TITLE","タイトル テキスト"
createDocumentメソッドで一般的に使用される有効なドキュメント属性値の例を以下の表に示します。 タイプ列は実際のタイプを指定します。メソッドで使用する場合は、文字列形式にパースしてattrVals文字列配列に指定する必要があります。
属性値
タイプ
説明
PRIMARY_INDEX
整数
ドキュメントを作成するカテゴリIDを指定します。
ルート
カテゴリには 1 を使用します。
USER_DEF_ID
文字列
ドキュメントを識別するために使用する任意のIDを指定します。
TITLE
文字列
ドキュメントのタイトルを指定します。
SUMMARY
文字列
ドキュメントの概要を指定します。
PROBLEM
文字列
ドキュメントの問題を指定します。
RESOLUTION
文字列
ドキュメントの解決策を指定します。 これにはHTMLも含めることができます。
STATUS_ID
整数
ドキュメントのステータスIDを指定します。 デフォルトは 10(ドラフト)です。
PRIORITY_ID
整数
ドキュメントの優先度IDを指定します。 初期設定は20(中)です。
CREATION_DATE
Date (String)
ドキュメントが作成された日付と時間を指定します。 指定しない場合、現在の日付が割り当てられます。
MODIFY_DATE
Date (String)
ドキュメントが最後に変更された日付と時間を指定します。 指定しない場合、現在の日付が割り当てられます。
START_DATE
Date (String)
ドキュメントがアクティブになった日付を指定します。Expiration_Dateと組み合わせて使用します。 開始日を指定せずに空白のままにしておくと、有効期限に達するまでの間、ドキュメントはアクティブのままになります。
EXPIRATION_DATE
Date (String)
ドキュメントの有効期限を指定します。Start_Date と組み合わせて使用します。 有効期限を指定しない場合は空白にします。
PUBLISHED_DATE
Date (String)
ドキュメントが発行された日付と時間を指定します。 ステータスが「発行済み」の場合、空白にして現在の日付を割り当てます。 ステータスが「発行済み」以外の場合、このパラメータは無視されます。
SD_PRODUCT_ID
整数
このドキュメントを関連付ける CA SDM の製品 ID を指定します。
ASSIGNEE_ID
UUID
このドキュメントに割り当てられる CA SDM の一意の担当者 ID を指定します。
SD_ASSET_ID
UUID
このドキュメントを関連付ける CA SDM のアセット ID を指定します。
SD_ROOTCAUSE_ID
整数
このドキュメントを関連付ける CA SDM の根本原因 ID を指定します。
SD_PRIORITY_ID
整数
このドキュメントを関連付ける CA SDM の優先度 ID を指定します。
SD_SEVERITY_ID
整数
このドキュメントを関連付ける CA SDM の重大度 ID を指定します。
SD_IMPACT_ID
整数
このドキュメントを関連付ける CA SDM の影響 ID を指定します。
SD_URGENCY_ID
整数
このドキュメントを関連付ける CA SDM の緊急度 ID を指定します。
AUTHOR_ID
UUID
このドキュメントの作成者である連絡先の固有IDを指定します。 作成者が内部連絡先ではない場合、このフィールドを0に設定して、代わりにAuthorパラメータを使用することができます。
OWNER_ID
UUID
このドキュメントの担当者である連絡先の固有IDを指定します。
SUBJECT_EXPERT_ID
UUID
このドキュメントのサブジェクト エキスパートである連絡先の固有IDを指定します。
NOTES
文字列
ドキュメントの注意事項を指定します。
READ_GROUP_LIST
文字列
このドキュメントの読み取り許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-3-4)。 全員に許可を割り当てるには「
A
」を指定します。
WRITE_GROUP_LIST
文字列
このドキュメントの書き込み許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-3-4)。 全員に許可を割り当てるには「
A
」を指定します。
INHERITPERMISSIONS
ブール値
ドキュメントが作成されるカテゴリから許可を継承するかどうかを表すフラグのステータスを指定します。
許可を継承する場合は True に設定します。そうすると、読み取り許可および書き込み許可のパラメータは無視されます。
DOC_TYPE_ID
整数
ドキュメントのタイプ(標準ドキュメントまたはツリー ドキュメント)のIDを指定します。 初期設定は標準ドキュメントです。
HITS
整数
ドキュメントが表示された回数を指定します。
DOC_TEMPLATE_ID
整数
このドキュメントに割り当てるテンプレートのIDを指定します。
WF_TEMPLATE
整数
このドキュメントに割り当てるワークフロー テンプレートのIDを指定します。
CUSTOM1
文字列
カスタム フィールドを指定します。
CUSTOM2
文字列
カスタム フィールドを指定します。
CUSTOM3
文字列
カスタム フィールドを指定します。
CUSTOM4
文字列
カスタム フィールドを指定します。
CUSTOM5
文字列
カスタム フィールドを指定します。
CUSTOM_NUM1
二重線
数値型のカスタム フィールドを指定します。
CUSTOM_NUM2
二重線
数値型のカスタム フィールドを指定します。
説明
新規ドキュメントを作成します。
戻り値
作成されたナレッジ ドキュメントを説明する <UDSObject> ノード。
modifyDocument
modifyDocumentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
変更するドキュメントの固有IDを指定します。
kdAttributes
String[]
更新する名前と値のペアを"SUMMARY", "概要テキスト", "TITLE", "タイトル テキスト"のように指定します。
modifyDocumentメソッドで一般的に使用される有効なドキュメント属性値の例を以下の表に指定します。 タイプ列は実際のタイプを指定します。メソッドで使用する場合は、文字列形式にパースしてattrVals文字列配列に指定する必要があります。
パラメータ
タイプ
説明
MODIFY_DATE
(String)
「レコードをロックする」ために使用する特別なフィールドです。2 人のユーザが同時に同じドキュメントを更新することを防ぎます。 ドキュメントの既存MODIFY_DATEで渡す必要があります。 この MODIFY_DATE を空白にした場合は、別のユーザがドキュメントを更新したというエラーを受け取ります。
USER_DEF_ID
文字列
ドキュメントを識別するために使用する任意のIDを指定します。
TITLE
文字列
ドキュメントのタイトルを示します。
SUMMARY
文字列
ドキュメントの概要を示します。
PROBLEM
文字列
ドキュメントの問題を示します。
RESOLUTION
文字列
ドキュメントの解決策を示します。 これにはHTMLも含めることができます。
STATUS_ID
整数
ドキュメントのステータスIDを示します。 デフォルトは 10(ドラフト)です。
PRIORTY_ID
整数
ドキュメントの優先度IDを示します。 初期設定は20(中)です。
START_DATE
Date (String)
ドキュメントがアクティブになる日付を示します。これも有効期限と組み合わせて使用します。 開始日を指定せずに空白のままにしておくと、有効期限が過ぎるまでの間、ドキュメントはアクティブのままになります。
EXPIRATION_DATE
Date (String)
ドキュメントの有効期限を示します。開始日と組み合わせて使用します。 有効期限を指定しない場合は空白にします。
SD_PRODUCT_ID
整数
このドキュメントを関連付ける CA SDM の製品 ID を示します。
ASSIGNEE_ID
UUID
このドキュメントに割り当てられる CA SDM の一意の ID を示します。
SD_ASSET_ID
UUID
このドキュメントを関連付ける CA SDM のアセット ID を示します。
SD_ROOTCAUSE_ID
整数
このドキュメントを関連付ける CA SDM の根本原因 ID を示します。
SD_PRIORITY_ID
整数
このドキュメントを関連付ける CA SDM の優先度 ID を示します。
SD_SEVERITY_ID
整数
このドキュメントを関連付ける CA SDM の重大度 ID を示します。
SD_IMPACT_ID
整数
このドキュメントを関連付ける CA SDM の影響 ID を示します。
SD_URGENCY_ID
整数
このドキュメントを関連付ける CA SDM の緊急度 ID を示します。
AUTHOR_ID
UUID
このドキュメントの作成者である連絡先の固有IDを指定します。 作成者が内部連絡先ではない場合、このフィールドを0に設定して、代わりにAuthorパラメータを使用することができます。
OWNER_ID
UUID
このドキュメントの担当者である連絡先の固有IDを指定します。
SUBJECT_EXPERT_ID
UUID
このドキュメントのサブジェクト エキスパートである連絡先の固有IDを指定します。
NOTES
文字列
ドキュメントの注意事項を指定します。
READ_GROUP_LIST
文字列
このドキュメントの読み取り許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-2-3)。 全員に許可を割り当てるには「
A
」を指定します。
WRITE_GROUP_LIST
文字列
このドキュメントの書き込み許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-3-4)。 全員に許可を割り当てるには「
A
」を指定します。
INHERIT_PERMISSION
ブール値
許可を継承するためのフラグのステータスを指定します。 ドキュメントが作成されるカテゴリから許可を継承する場合、Trueを設定します。 Trueに設定した場合は、読み取り許可および書き込み許可のパラメータは無視されます。
DOC_TYPE_ID
整数
ドキュメントのタイプ(標準ドキュメントまたはツリー ドキュメント)のIDを指定します。 初期設定は標準ドキュメントです。
HITS
整数
ドキュメントが表示された回数を指定します。
DOC_TEMPLATE_ID
整数
このドキュメントに割り当てるテンプレートのIDを指定します。
WF_TEMPLATE
整数
このドキュメントに割り当てるワークフロー テンプレートのIDを指定します。
WF_ACTION
文字列
このドキュメントに割り当てるワークフローのアクションを指定します。 たとえば、「wf_unpublish」では、ドキュメントは発行停止になります。
WF_COMMENT
文字列
このドキュメントに割り当てるワークフローのコメントを指定します。 たとえば、「unpublish」と指定します。
WF_CONTACT_ID
UUID
このドキュメントに割り当てるワークフローのユーザ ID を指定します。
WF_REJECT_TO_ID
整数
承認プロセスと一致する、このドキュメントに割り当てるワークフローのタスク ID を指定します。 タスク ID は、CI_ACTIONS テーブルに格納されます。
CUSTOM1
文字列
カスタム フィールドを指定します。
CUSTOM2
文字列
カスタム フィールドを指定します。
CUSTOM3
文字列
カスタム フィールドを指定します。
CUSTOM4
文字列
カスタム フィールドを指定します。
CUSTOM5
文字列
カスタム フィールドを指定します。
CUSTOMNUM1
二重線
数値型のカスタム フィールドを指定します。
CUSTOMNUM2
二重線
数値型のカスタム フィールドを指定します。
説明
ドキュメントを変更します。
戻り値
変更されたナレッジ ドキュメントを説明する <UDSObject> ノード。
deleteDocument
deleteDocumentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
削除するドキュメントの固有IDを指定します。
説明
削除するドキュメントにフラグを立てます。 ナレッジ管理の Windows サービスによってドキュメントは永久に削除されます。
戻り値
エラーが発生した場合のみ、
エラーのエラー コードを返します。 詳細については、「エラー コード」を参照してください。
ナレッジ管理 Web サービスの使用
ナレッジ管理のWeb サービスで表示されるログイン プロセスおよびエラー コードは、CA SDM の Web サービスの場合と同じです。 詳細については、「ログイン」および「エラー コード」を参照してください。
ナレッジ管理 Web サービスへのアクセス
ナレッジ管理の Web サービスは、W3C が定めた標準を実装した Apache Axis を採用しています。 クライアント プラットフォームの種類に関係なくサービスにアクセスできることが理想ですが、ベンダの実装によってはアクセスできないこともあります。 たとえば、Javaおよび.NETでは、WSDLサービスの記述からプロキシ クラスを生成するツールを提供しています。 異なるテクノロジを使用するWebサービスを使用して問題が発生した場合は、プラットフォームのベンダー、またはMicrosoftのナレッジ ベースで確認してください。
addComment
addCommentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
comment
文字列
追加するコメントを指定します。
docId
整数
追加するコメントのドキュメントIDを指定します。
email
文字列
コメント送信者の電子メール アドレスを指定します。 ユーザIDパラメータに基づいてデータベースから電子メール アドレスを取得する場合は空白にします。
username
文字列
コメント送信者のユーザ名を指定します。 ユーザ ID パラメータに基づいてデータベースからユーザ名を取得する場合は空白にします。
contactId
文字列
コメント送信者のIDを指定します。 この連絡先IDがデータベースに存在する場合は、関連付けられている電子メール アドレスおよびユーザ名が取得され、電子メール フィールドとユーザ名フィールドに返されます。 このIDが存在しない場合は、電子メール アドレスおよびユーザ名のパラメータが代わりに使用されます(これらのパラメータを与えた場合)。 このパラメータを使用しない場合は、0を指定します。 連絡先IDは文字列形式のUUIDです。
説明
特定のドキュメントにコメントを追加します。
戻り値
<UDSObject> ノード。ノード内に、最後に追加されたコメントを説明する以下の <Attributes> 子ノードを含みます。
XML エレメントの値
データ タイプ
説明
id
整数
最後に追加されたコメントの固有IDを示します。
DOC_ID
整数
最後に追加されたコメントのドキュメントIDを示します。
USER_ID
整数
コメント送信者のIDを示します。
USER_NAME
文字列
コメント送信者のユーザ名を示します。
EMAIL_ADDRESS
文字列
コメント送信者の電子メール アドレスを示します。
COMMENT_TEXT
文字列
最後に追加されたコメントのテキストを示します。
COMMENT_TIMESTAMP
日付
コメントが追加された日付と時間を示します。
deleteComment
deleteComment メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
commentId
整数
削除するコメントの一意の ID を指定します。
説明
コメントを削除します。
戻り値
エラーのエラー コードのみを返します。 詳細については、「エラー コード」を参照してください。
rateDocument
rateDocumentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
評価するドキュメントIDを指定します。
rating
整数
ドキュメントに与える評価を指定します(評価段階は0~4。0は最低で4は最高)。
multiplier
整数
乗数パラメータを指定します。 このパラメータを使用すると、一度に複数回の評価を実行したように処理できます。 評価を1回だけ実行するには初期設定の1を使用し、複数回実行するには他の数字を使用します。
たとえば、3を指定した場合、メソッドを3回コールしたかのように処理が行われます。 この結果、rating パラメータに指定した評価が 3 つ、データベースに追加されます。
ticketPerId
文字列
このナレッジ ドキュメントに関連するチケットの固定IDを指定します。
onTicketAccept
ブール値
ドキュメントがチケットのソリューションとして受け入れられたかどうかを示します。
solveUserProblem
ブール値
このドキュメントによりユーザの問題が解決されたかどうかを示します。 これは、解決策に関する調査の質問「このドキュメントで問題が解決されましたか。」に対してユーザがどのように回答したかを表します。
isDefault
ブール値
評価ステータスの初期設定を指定します。 ユーザがドキュメントを表示したにも関わらず、評価を行わなかった場合に評価を設定するには、この値をTrueに設定します。 これは原因をレポートするために使用します。
説明
特定のドキュメントを評価します。
戻り値
<UDSObject> ノード。ノード内に、評価のBU_TRANSを説明する以下の <Attributes> 子ノードを含みます。
XML エレメントの値
データ タイプ
説明
id
整数
最後に追加された評価の固有IDを示します。 後で評価を変更する場合は、updateRating()メソッドでこの値を使用します。
DOC_ID
整数
ドキュメントIDを示します。
INDEX_ID
整数
カテゴリIDを示します。
BU_RATING
文字列
ドキュメントに与えられた評価を示します。
HIT_NO_VOTE
整数
ユーザがドキュメントを表示したにも関わらず評価を行わなかった場合に設定された評価、またはユーザがドキュメントを表示しなかったにも関わらず評価を行った場合に設定された評価を示します。
updateRating
updateRating メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
buID
整数
変更する評価の一意の ID を指定します。 この ID は rateDocument() メソッドによって返されます。
rate
整数
ドキュメントに適用する新しい評価を指定します(評価段階は 0~4。0 が最低で 4 が最高)。
説明
特定ドキュメントの評価の 1 つを更新します。
戻り値
BU_TRANS を説明する <UDSObject> ノード。ノードには、更新された評価属性が含まれています。
getQuestionsAsked
getQuestionsAsked メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
resultSize
整数
詳細情報を取得する検索結果テキストの数を指定します。
降順
ブール値
結果を ASKED_DATE の降順で並べ替えるかどうかを指定します。
説明
ナレッジ ドキュメントの履歴から検索テキストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して EBR_LOG を説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
データ タイプ
説明
id
整数
たずねられた質問の一意の ID を示します。
SEARCH_TEXT
整数
たずねられた質問の検索テキストを示します。
getBookmarks
getBookmarksメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
contactId
文字列
ブックマークを取得する連絡先の固有IDを指定します。 連絡先IDは文字列形式のUUIDです。
説明
特定の連絡先のブックマークを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して CI_STATUSES を説明する 0 個以上の <UDSObject> ノードが含まれています。
XMLエレメントの名前
タイプ
説明
DOCUMENT_ID
整数
ドキュメントの固有IDを示します。
id
整数
ブックマークIDを示します。
USER_ID
文字列
このブックマークの所有者のユーザIDを示します。
BOOKMARK_TITLE
文字列
ドキュメントのブックマーク タイトルを示します。
addBookmark
addBookmark メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
contactId
文字列
ブックマークを取得する連絡先の固有IDを指定します。 連絡先IDは文字列形式のUUIDです。
docId
整数
ブックマークするドキュメント ID を指定します。
説明
特定の連絡先のブックマークを追加します。
戻り値
新規作成したブックマークを説明する <UDSObject> ノード。
deleteBookmark
deleteBookmark メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
contactId
文字列
ブックマークを削除する連絡先の一意の ID を指定します。 連絡先 ID は文字列形式の UUID です。
docId
整数
削除するブックマークのドキュメント ID を指定します。
説明
特定の連絡先のブックマークを削除します。
戻り値
エラーのエラー コードのみを返します。 詳細については、「エラー コード」を参照してください。
getStatuses
getStatuses メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
説明
ステータスのリストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して CI_STATUSES を説明する 0 個以上の <UDSObject> ノードが含まれています。
XMLエレメントの値
データ タイプ
説明
id
整数
ステータスの一意の ID を示します。
STATUS
文字列
ステータスの名前を示します。
STATUS_DESCRIPTION
文字列
ステータスの説明を示します。
PREDEFINED
整数
ステータスがナレッジ管理システムによって事前定義されているかどうかを示します。事前定義されている場合は削除できません。
STATUS_ORDER
整数
ステータスがワークフロー タスク リストに表示される順序を説明します。 ワークフローはこの順序に従った場合にのみ、作成することができます。
getPriorities
getPriorities メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
説明
優先度のリストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して CI_STATUSES を説明する 0 個以上の <UDSObject> ノードが含まれています。
XMLエレメントの値
データ タイプ
説明
id
整数
優先度の一意の ID を示します。
PRIORITY
文字列
優先度の名前を示します。
getDocumentTypes
getDocumentTypes メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
説明
ドキュメント タイプのリストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して CI_STATUSES を説明する 0 個以上の <UDSObject> ノードが含まれています。
XMLエレメントの値
データ タイプ
説明
id
整数
ドキュメント タイプの固有IDを示します。
DOC_TYPE_TXT
文字列
ドキュメント タイプの名前を示します。
getTemplateList
getTemplateList メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
説明
ドキュメント テンプレートのリストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して CI_STATUSES を説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
id
整数
ドキュメント タイプの固有IDを示します。
TEMPLATE_NAME
文字列
ドキュメント テンプレートの名前を示します。
IS_PREDEFINED
整数
テンプレートがナレッジ管理システムによって事前定義されているかどうかを示します。事前定義されている場合は削除できません。
IS_DEFAULT
整数
テンプレートがデフォルトで新規ドキュメントに割り当てられるかどうかを示します。
getWorkflowTemplateList
getWorkflowTemplateList メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
説明
ワークフロー テンプレートのリストを取得します。
戻り値
<UDSObjectList> ノード。ノードには、以下の <Attributes> 子ノードを使用して WF_TEMPLATE を説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
id
整数
ワークフロー テンプレートの一意の ID を示します。
WF_NAME
文字列
ワークフロー テンプレートの名前を示します。
WF_DESCRIPTION
文字列
ワークフロー テンプレートの説明を示します。
IS_DEFAULT
整数
デフォルトのテンプレートが新規ドキュメントに割り当てられることを示します。