Webサービス ビジネス メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービスのビジネス メソッドについて説明します。
createIssue
createIssue メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creatorHandle
文字列
案件作成担当者の連絡先のハンドルを指定します(ログ エージェント)。 デフォルトの CA SDM ユーザを指定するには、空の文字列を渡します。
attrVals
String[]
新規案件の初期属性値の設定に使用される名前と値のペアの配列を指定します。
注:
ドット付きの名前は使用できません。
propertyValues
String[]
(オプション)新規案件に添付されるプロパティ値の配列を指定します。
template
文字列
(オプション)案件を作成する案件テンプレート(iss_tpl オブジェクト)のハンドルを指定します。
attributes
String[]
値を返す新規オブジェクトの属性名を配列で指定します。 ドット表記を使用することができます。 このフィールドが空の場合は、すべての属性値が返されます。
newIssueHandle
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
newIssueNumber
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
説明
CA SDM の案件 (iss) オブジェクトを作成します。 プロパティを持つ案件オブジェクトを作成する方法については、createRequest() を参照してください。
案件を作成するには、この関数を使用する
必要があります
。createObject() は使用しないでください。
戻り値
新規オブジェクトのハンドルが
「すべて」
の属性値と共に返されます。 ListおよびLRELタイプは空のエレメントとして返されます。
XML エレメント
タイプ
説明
<UDSObject>
N/A
ハンドルおよびリクエストされた属性値を含む、標準UDSObjectエレメントを示します。
<newIssueHandle>
文字列
新規案件のハンドルを示します。
<newIssueNumber>
文字列
新規案件の番号(「ref_num」属性)を示します。
createRequest
createRequest メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creatorHandle
文字列
リクエスト作成担当者の連絡先のハンドルを指定します(ログ エージェント)。 デフォルトの CA SDM ユーザを指定するには、空の文字列を渡します。
attrVals
String[]
新規リクエストの初期属性値の設定に使用される名前と値のペアの配列を指定します。
注:
ドット付きの名前は使用できません。
propertyValues
String[]
新規リクエストに添付されるプロパティ値の配列を指定します。
template
文字列
(オプション)リクエストを作成するリクエスト テンプレート(cr_tpl)のハンドルを指定します。
attributes
String[]
値を返す新規オブジェクトの属性名を配列で指定します。
ドット表記を使用することができます。 このフィールドが空の場合は、値を表す属性値がすべて返されます。
newRequestHandle
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
newRequestNumber
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
説明
CA SDM のリクエスト (cr) オブジェクトを作成します。 リクエストを作成するには、この関数を使用する
必要があります
。createObject() は使用しないでください。
propertyValues
は、新規リクエストに添付する各プロパティ オブジェクトの値のリストです。 添付するプロパティは、新規リクエストの「categoy」属性値によって定義されます。 CA SDM Web サービス インターフェースで作成したプロパティにはデフォルト値が設定されています(詳細については、「カテゴリおよびプロパティ」を参照)。リクエストはすべての「必須」プロパティに値が設定されるまで保存されないため、デフォルト値は重要です。
リクエスト作成時に添付するプロパティは、ユーザが値を設定してデフォルト値を上書きできます。 createRequest() は最後に作成するオブジェクトを保存しようとするため、こうした情報はリクエストを作成する前に入力する必要があります。 特定のカテゴリのプロパティ リストを取得するには、getPropertyInfoForCategory() を使用します。 この関数は、「sequence」属性の順序でプロパティを返します。これは予想される
propertyValues
配列の順序です。 たとえば、一連のプロパティとシンボルが以下のようになっているとします。
100 - Hard Drive Size 200 - CPU 300 - Memory
propertyValues
配列は、プログラミング言語に応じて以下のように表示されます。
["40 GB", "Pentium 4 1.7 Ghz", "256"]
getPropertyInfoForCategory() は、どのプロパティが
必須
であるかを示します。
リクエスト カテゴリを設定しない場合、またはプロパティの値を設定しない場合は、
propertyValues
に空の文字列を渡します。
プロパティのデフォルト値を使用しない場合は、以下のような順序で新規のリクエスト、案件、または変更要求を作成することをお勧めします。
  1. カテゴリ/領域のリストを取得します。 リクエスト領域のオブジェクト名は「pcat」です。
  2. getPropertyInfoForCategory() をコールして、新規のリクエスト、案件、または変更要求のカテゴリのプロパティ リストを確認します。
  3. 返された各プロパティに対する値の配列を作成します。 この配列は作成時の操作で使用する
    propertyValues
    パラメータに指定します。
  4. attrVals
    配列を構築して、作成メソッドをコールします。
上記に代わる手順として、createRequest() が返された後、getRelatedListValues() を使用してプロパティ リストを取得することもできます。 プロパティはリクエストごとの「プロパティ」リストに保管されます。
アプリケーションによっては、少なくともカテゴリ リストをキャッシュするほうが速い場合があります。このデータがほとんどのクライアント サイトでそれほど頻繁に変更されないためです。
デフォルトでは、このメソッドでリクエストが作成されます。 ITIL 方式を使用している場合は、attrVals 配列に「type」属性を設定して、インシデントと問題チケットのどちらを作成するかを定義する必要があります。 ITIL 手順の詳細については、「ITIL 方式」を参照してください。
戻り値
新規オブジェクトのハンドルが
「すべての」
属性値と共に返されます。 ListおよびLRELタイプは空のエレメントとして返されます。
XML エレメント
タイプ
説明
N/A
ハンドルおよびリクエストされた属性値を含む、標準UDSObjectエレメントを示します。
<newRequestHandle>
文字列
新規リクエストのハンドルを指定します。
<newRequestNumber>
文字列
新規リクエストの番号(「ref_num」属性)を示します。
createChangeOrder
createChangeOrder メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creatorHandle
文字列
変更要求作成担当者の連絡先のハンドルを指定します(ログ エージェント)。 デフォルトの CA SDM ユーザを指定するには、空の文字列を渡します。
attrVals
String[]
変更要求の初期属性値の設定に使用される名前と値のペアの配列を指定します。
注:
ドット付きの名前は使用できません。
propertyValues
String[]
(オプション)新規変更要求に添付されるプロパティ値の配列を指定します。
template
文字列
(オプション)変更要求を作成する変更テンプレート(chg_tpl オブジェクト)のハンドルを指定します。
attributes
String[]
値を返す新規オブジェクトの属性名を配列で指定します。
ドット表記を使用することができます。 このフィールドが空の場合は、値を表す属性値がすべて返されます。
newChangeHandle
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。
newChangeNumber
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。
説明
CA SDM 変更要求 (chg) オブジェクトを作成します。
変更要求を作成
するには、この関数を使用する必要があります。createObject() は使用しないでください。
戻り値
新規オブジェクト ハンドルが、その
すべての
属性値と共に返されます。 ListおよびLRELタイプは空のエレメントとして返されます
XML エレメント
タイプ
説明
<UDSObject>
N/A
ハンドルおよびリクエストされた属性値を含む、標準 UDSObject エレメントを示します。
<newChangeHandle>
文字列
新規変更要求のハンドルを指定します。
<newChangeNumber>
文字列
新規変更要求の番号(「chg_ref_num」属性)を指定します。
createActivityLog
createActivityLog メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creator
文字列
アクティビティ担当者の連絡先のハンドルを指定します。
objectHandle
文字列
リクエスト、案件、または変更要求のハンドルを指定します。 その他のオブジェクト タイプはすべて拒否されます。
description
文字列
アクティビティ ログに表示されるアクティビティの説明を指定します。
LogType
文字列
作成するログのタイプを指定します。以下の説明を参照してください。
TimeSpent
整数
アクティビティ ログの所要時間フィールドを設定します。これはアクティビティの期間です。 デフォルトを使用する場合、ゼロを渡します。
内部
ブール値
以下の値を指定します。
True = 内部専用アクティビティ
False = すべてのユーザが表示できる非内部アクティビティ
説明
指定したリクエスト、案件、または変更要求のアクティビティ ログを作成します。 このメソッドは、 CA SDM インターフェースにおいて、変更/リクエスト/案件の詳細の[アクティビティ]-[ログ コメント]/[調査]/[コールバック]に対応します。
LogType
は新規ログのアクティビティ ログのコード属性です。 よく使用されるコードは以下のとおりです。
  • 「CB」(コールバック)
  • 「RS」(調査)
  • 「LOG」(ログ コメント)
CA SDM 管理クライアントもコード値を表示します。 コード値を表示するには、メイン メニューから[管理]-[通知]-[アクティビティの通知]を選択します。
戻り値
作成されたアクティビティ ログ オブジェクトのハンドル。
XML エレメント
タイプ
説明
<LogHandle>
文字列
新規アクティビティ ログのハンドルを示します。
transfer
transfer メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creator
文字列
アクティビティ担当者の連絡先のハンドルを指定します。
objectHandle
文字列
リクエスト、案件、または変更要求のハンドルを指定します。 その他のオブジェクト タイプはすべて拒否されます。
description
文字列
アクティビティ ログに表示されるアクティビティの説明を指定します。
setAssignee
ブール値
値が true の場合、newAssignee の値で担当者フィールドが更新されます。
newAssigneeHandle
文字列
オブジェクトの新規担当者を指定します。
setGroup
ブール値
true の場合、グループ フィールドを更新します。
newGroupHandle
文字列
オブジェクトの新規グループを指定します。
setOrganization
ブール値
値が true の場合、組織を更新します。
newOrgnizationHandle
文字列
(案件および変更要求のみ)オブジェクトの新規組織を指定します。
説明
案件、リクエスト、または変更要求の転送アクティビティを実行します。 このメソッドは、 CA SDM インターフェースの[アクティビティ]-[転送]コマンドに対応します。 このメソッドは、アクティビティ ログを生成し、オプションで新規の担当者、グループ、または組織を設定します。
setAssignee/setGroup/setOrganization
パラメータを 1 つ以上 true に設定すると、対応するフィールドの値(担当者、グループ、または組織)が更新されます。
対応する値がフィールドに渡された場合でも、パラメータが false の場合、フィールドは更新されません。 たとえば、
setAssignee
が false の場合、
newAssignee
で値を指定しても、担当者は更新されません。
setXXXX
パラメータがtrueの場合、フィールドが更新されます。 フィールドを空/Nullに設定するには、空の文字列を渡します。
戻り値
作成されたアクティビティ ログ オブジェクトへのハンドル。 戻り値は <Logs> という名前の親エレメントの下にあります。
XML エレメント
タイプ
説明
<LogHandle>
文字列
新規アクティビティ ログのハンドルを示します(0個以上のハンドルが返されます)。
escalate
escalate メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creator
文字列
アクティビティ担当者の連絡先のハンドルを指定します。
objectHandle
文字列
リクエスト、案件、または変更要求のハンドルを指定します。 その他のオブジェクト タイプはすべて拒否されます。
description
文字列
アクティビティ ログに表示されるアクティビティの説明を指定します。
setAssignee
ブール値
true の場合、担当者フィールドを更新します。
newAssigneeHandle
文字列
オブジェクトの新規担当者のハンドルを指定します
setGroup
ブール値
true の場合、newGroupHandle の値でグループ フィールドを更新します。
newGroupHandle
文字列
オブジェクトの新規グループのハンドルを指定します
setOrganization
ブール値
true の場合、newOrganizationHandle に指定した値を組織フィールドに設定します。
newOrgnizationHandle
文字列
(案件および変更要求のみ)オブジェクトの新規組織のハンドルを指定します
setPriorityHandle
ブール値
true の場合、newPriority に指定した値で優先度フィールドを更新します。
newPriority
文字列
オブジェクトの新規優先度のハンドルを指定します。
説明
案件、リクエスト、または変更要求のエスカレート アクティビティを実行します。 このメソッドは、アクティビティ ログを生成し、オプションで新規の担当者、グループ、優先度、および/または組織を設定します。
このメソッドは、 CA SDM インターフェースの[アクティビティ]-[エスカレート]コマンドに対応します。
setAssignee/setGroup/setOrganization
パラメータを 1 つ以上 true に設定すると、対応するフィールドの値(担当者、グループ、または組織)が更新されます。 対応する値がフィールドに渡された場合でも、パラメータが false の場合、フィールドは更新されません。 たとえば、
setAssignee
が false の場合、
newAssignee
で値を指定しても、担当者は更新されません。
setXXXX
パラメータがtrueの場合、フィールドが更新されます。 フィールドを空/Nullに設定するには、空の文字列を渡します。
リクエストに組織は使用されません。
戻り値
作成されたアクティビティ ログ オブジェクトへのハンドル。
XML エレメント
タイプ
説明
<LogHandle>
文字列
新規アクティビティ ログのハンドルを示します(0個以上のハンドルが返されます)。
changeStatus
changeStatus メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
creator
文字列
アクティビティ担当者の連絡先のハンドルを指定します。
objectHandle
文字列
リクエスト、案件、または変更要求のハンドルを指定します。 その他のオブジェクト タイプはすべて拒否されます。
description
文字列
アクティビティ ログに表示されるアクティビティの説明を指定します。
newStatusHandle
文字列
オブジェクトのステータスのハンドルを指定します。
説明
案件、リクエスト、または変更要求のステータス変更アクティビティを実行します。 このメソッドは、アクティビティ ログを生成し、オプションでステータスの値を設定します。 このメソッドは、 CA SDM インターフェースの[アクティビティ]-[ステータスの更新]コマンドに対応しています。
戻り値
作成されたアクティビティ ログ オブジェクトのハンドル。
XML エレメント
タイプ
説明
<LogHandle>
文字列
新規アクティビティ ログのハンドルを示します(0個以上のハンドルが返されます)。
getPropertyInfoForCategory
getPropertyInfoForCategory メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
categoryHandle
文字列
カテゴリ ハンドルを指定します。
attributes
String[]
値をフェッチするプロパティ テンプレート オブジェクトの属性名を 1 つ以上指定します。 これが空の場合は、値に基づく属性がすべてフェッチされます。
説明
特定のカテゴリのプロパティに関する情報です。 このメソッドを使用して、リクエスト/案件/変更要求プロパティに、挿入操作時にユーザ定義のデータをあらかじめ入力しておくことができます。
カテゴリによっては、このメソッドは「prptpl」または「cr_prptpl」オブジェクト タイプをクエリします。 どちらのタイプもほとんど同じです。 「sequence」、「label」、「description」、および「required」属性をフェッチすることをお勧めします。
戻り値
「sequence」属性の順序で一連の <UDSObject> エレメントを含む、<UDSObject> エレメントが返されます。
logComment
logComment メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
ticketHandle
文字列
アクティビティ ログを追加するチケットのハンドルを指定します。
コメント
文字列
コメント テキストを指定します。
internal_flag
文字列
内部フラグを指定します。 新規アクティビティ ログを内部ログとして記録する場合は True に設定します。
説明
チケットに「ログ コメント」アクティビティ ログを添付します。 このメソッドは、createActivityLog() を簡易化したものです。
戻り値
なし。