getCategory メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
getCategoryメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
categoryId
整数
ドキュメントを作成するカテゴリIDを指定します。
getCategoryPaths
ブール値
カテゴリ情報を取得するパスを指定します。 カテゴリ情報、および各カテゴリの完全なテキスト カテゴリ パスが返されます。
説明
子カテゴリのすべてのリストを含む、カテゴリ情報を取得します。
戻り値
<UDSObjectList> ノード。ノード内に、リクエストされたカテゴリを説明する <UDSObject> ノードを含みます。
getPermissionGroups
getPermissionGroups メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
groupID
整数
この ID を持つグループだけが返されます。 このパラメータを使用しない場合はゼロ(0)を渡します。
注:
この groupID は、ナレッジ カテゴリに関連するものであり、連絡先の groupID とは異なります。
説明
許可グループのリストを取得します。
戻り値
<UDSObject> ノード。このノードには、以下の <Attributes> 子ノードを使用して許可グループを説明する 0 個以上の <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
id
整数
グループの一意の ID を示します。
GRP_LIST_KEY
文字列
カンマで区切った CA SDM グループ ID のリストを示します。
GRP_LIST
文字列
グループ リスト全体を含むフィールドを示します。
getComments
getCommentsメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docIds
文字列
取得するすべてのコメントのドキュメントIDを指定します。
注:
「400001,400002」のように、カンマで区切ります。
説明
ドキュメントからすべてのコメントを取得します。
戻り値
<UDSObjectList>ノード。ノード内に、以下の <Attributes> 子ノードを使用してO_COMMENTSを説明する 0 個以上の <UDSObject> ノードを含みます。
XML エレメントの値
データ タイプ
説明
id
整数
最後に追加されたコメントの固有IDを示します。
DOC_ID
整数
最後に追加されたコメントのドキュメント ID を示します。
USER_ID
整数
コメント送信者のIDを示します。
USER_NAME
文字列
コメント送信者のユーザ名を示します。
EMAIL_ADDRESS
文字列
コメント送信者の電子メール アドレスを示します。
COMMENT_TEXT
文字列
最後に追加されたコメントのテキストを示します。
COMMENT_TIMESTAMP
日付
コメントが追加された日付と時間を示します。
getDecisionTrees
getDecisionTreesメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
propertyList
文字列
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
id
DOC_TYPE_ID
BU_RESULT
sortBy
文字列
結果の並べ替えに使用するデータベース フィールドを指定します。 デフォルトは ID です。 複数の並べ替えフィールドを指定することはできません。
別のフィールドを指定した場合は、そのフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。
descending
ブール値
結果を降順で並べ替えるかどうかを指定します。
説明
すべての決定ツリーを取得します。 決定ツリーは、ユーザがドキュメントに記載された特定の質問に答えた後で解決方法を提供するナレッジ ドキュメントです。
戻り値
<UDSObjectList> ノード。ノード内に以下のセクションが返されます。
<UDSObject> nodes with requested <Attributes> nodes
getDocument
getDocumentメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docId
整数
取得するドキュメントIDを指定します。
propertyList
文字列
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 指定しない場合、すべてのフィールドが取得されます。
relatedDoc
ブール値
このドキュメントに関連するドキュメントのリストを取得するかどうかを指定します。
getAttmnt
ブール値
ドキュメントの添付ファイルとURLリンクのリストを取得するかどうかを指定します。
getHistory
ブール値
ドキュメントの完全な履歴を取得するかどうかを指定します。
getComment
ブール値
ドキュメントのすべてのコメントを取得するかどうかを指定します。
getNotiList
ブール値
ドキュメントの電子メール通知リストを取得するかどうかを指定します。
説明
ドキュメントの情報を取得します。
戻り値
<UDSObject> ノードの説明セクションで説明した <UDSObject> ノード。ノード内に、propertyListパラメータで指定した属性の <Attributes> を含みます。
getDocumentsByIDs
getDocumentsByIDsメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
docIds
文字列
取得するドキュメントIDをカンマ区切りリストで指定します。
propertyList
文字列
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
id
DOC_TYPE_ID
BU_RESULT
sort By
文字列
結果の並べ替えに使用するデータベース フィールドを指定します。 デフォルトは ID ですが、複数の並べ替えフィールドを指定することはできません。 別のフィールドを指定した場合は、そのフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。
descending
ブール値
結果を降順で並べ替えるかどうかを指定します。
説明
情報を取得するドキュメントIDを渡して、1つ以上のドキュメントに関する情報を取得します。 このメソッドは通常、faq()またはsearch()メソッドをコールした後に使用します。 パフォーマンスを向上するため、これらのメソッドは、ユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについてはIDのみが返されます。 たとえば、[先頭]、[戻る]、[次へ]、[最後]といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。
戻り値
<UDSObjectList> ノード。ノード内に以下のセクションが返されます。
<UDSObject> nodes with requested <Attributes> nodes describing Knowledge Document
getDocumentsByIDs()のdocIdsパラメータには、これと同じ形式でIDを渡す必要があります。
getBopsid
getBopsid メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
contact
文字列
返される BOPSID に関連付けられているユーザの名前を指定します。
注:
これは CA SDM 連絡先名ではなく、システム ログイン名です。
説明
Web インターフェース URL の作成を容易にします。Web インターフェース URL を使用すると、ログインせずに既存ユーザの Web インターフェース画面を起動できます。 URL は以下のようになります。
http://host/CAisd/pdmweb.exe?BOPSID=nnnnn+OP=xxxx...
既存ユーザ(アナリストなど)が Web インターフェースを起動するには、まず、コール元アプリケーションで Web インターフェース URL を構築する必要があります。これには BOPSID トークン(Web インターフェース セキュリティ トークン)が必要です。 BOPSID トークンがない場合、選択した Web インターフェース画面(既存チケットの詳細ビューなど)を起動しようとしたときに、ログインを要求されます。 getBopsid メソッドによって、Name パラメータで指定したユーザ用の BOPSID を生成できます。 Name パラメータを指定しない場合は、現在の Web インターフェース BOPSID に関連付けられたユーザが使用されます。
許可なく権限の昇格が行われるのを防ぐため、現在のログインの BOPSID には、入力されたユーザと同じかそれ以上のアクセス権限が必要です。
戻り値
入力されたユーザ名に基づく BOPSID。 BOPSID を生成してから 30 秒以内に、その BOPSID を使用して Web インターフェースを起動する必要があります。
現在のログインの BOPSID には、入力されたユーザと同じかそれ以上のアクセス権限が必要です。
getConfigurationMode
getConfigurationMode メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
現在のログイン セッションのSIDを指定します。
説明
この方法では CA SDM のインストールが ITIL 方式かどうかを示す文字列が返されます。
戻り値
インストールが ITIL 方式の場合は、文字列「itil」が返されます。 それ以外の場合は、空の文字列が返されます。
getObjectValues
getObjectValues メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
objectHandle
文字列
クエリする CA SDM オブジェクトのハンドルを指定します。
attributes
String[]
フェッチする属性の名前を指定します。 このフィールドが空の場合は、オブジェクトの属性がすべて返されます。
注:
ドット付きの属性名がサポートされるのは、SREL タイプ属性に限られます。LREL/BREL/QREL タイプ属性ではサポートされません。
説明
オブジェクトの属性値が返されます。 コール元が 1 つ以上の属性名を渡してオブジェクトをフェッチします。ドット付きの名前を使用できます。
すべての値は文字列で返されます。 空/Null 属性は空の文字列で返されます。
戻り値
<UDSObject> エレメント。
XML エレメント
タイプ
説明
<UDSObject>
N/A
1 つの <Handle> エレメントと 0 個以上の <AttributeNameX> エレメントを含みます。
getObjectTypeInformation
getObjectTypeInformation メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
factory
文字列
クエリするオブジェクト タイプ(別名「ファクトリ」)を指定します。 これは以下のようなオブジェクトの majic 名です。
"cr" = リクエスト
説明
指定したオブジェクト タイプのすべての属性名のリスト、および各属性のタイプ情報が返されます。 ストレージ容量の要件を保存するために属性が必要な場合、属性のタイプに返される情報に、整数、文字列、日付、ポインタ、リストなどが含まれます。
コストのかかる、重複した複数のコールを避けるために、コール元は要求されたタイプ情報をオブジェクト タイプごとにキャッシュする必要があります。 属性情報が変更されるのは、CA SDM サーバで変更が実行され、サービスがリサイクルされた後のみです。
戻り値
以下の値が返されます。
XML エレメント
タイプ
説明
<UDSObject>
N/A
ルート ノードを示します。
<Attributes>
シーケンス
各属性の 0 個以上のエレメントを示します。
<attrName DataType="dataType" Size="storageSize" Required="Boolean" Factory="factoryName">
EmptyElement
オブジェクトの属性名に一致する名前のエレメントを示します。 エレメントには複数の属性があります。
DataType:
データ タイプを整数で表します。
サイズ:
この属性を文字列に格納するために必要な最大サイズを表します。
必須:
保存するオブジェクトでこの属性が必須の場合は True になります。
Factory:
属性が List、Lrel、または Pointer タイプの場合、オブジェクトのタイプ名を表します。 List、LREL、または Pointer タイプのデータ タイプでない限り、何も含まれません。
getArtifact
getArtifact メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
contact
文字列
返されたアーチファクトに関連付けられているユーザの名前を示します。
注:
これはシステムのログイン名です。CA Service Desk Manager の連絡先名ではありません。
password
文字列
パスワードを指定します。
説明
Web インターフェース URL の作成を容易にします。Web インターフェース URL を使用すると、ログインせずに既存ユーザの Web インターフェース画面を起動できます。 URL は以下のようになります。
http://host/CAisd/pdmweb.exe?USERNAME=xxxxx+ARTIFACT=nnnnn+OP=xxxx....
既存ユーザ(アナリストなど)が Web インターフェースを起動するには、まず、コール元アプリケーションで Web インターフェース URL を構築する必要があります。これには CA EEM アーチファクト トークン(Web インターフェース セキュリティ トークン)が必要です。 CA EEM アーチファクト トークンがない場合、選択した Web インターフェース画面(既存チケットの詳細ビューなど)を起動したときに、ログインを要求されます。 getArtifact メソッドによって、contact パラメータで指定したユーザの CA EEM アーチファクト トークン を生成できます。
この操作を行うには、Service Desk と CA EEM が統合されている必要があります。
戻り値
入力されたユーザ名に基づく CA EEM アーチファクト。 アーチファクトを使用して、Web インターフェースを 1 度だけ起動することができます。