Web サービスのその他のメソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービスのその他のメソッドについて説明します。
callServerMethod
callServerMethod メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
methodName
文字列
コールするメソッドの名前を指定します。
factoryName
文字列
メソッドを含むオブジェクト タイプのファクトリ名を指定します。
formatList
文字列
フォーマット リストを指定します。これは受信パラメータのデータ タイプを示す文字の集まりです。 この表内の Parameter() の説明に関連します。
パラメータ
String[]
メソッドのパラメータ値を 0 個以上指定します。
説明
このメソッドは、サーバ側の任意のメソッドを呼び出すために使用します。 これらは独自の「spel」スクリプト言語によって定義されたメソッドです。
ファクトリ メソッドのみコールできます。コール元はログイン時に完全な管理者権限が必要です。
フォーマット リストは、0 個以上の文字の集まりで構成され、後続のパラメータのデータ タイプを順番に示します。 文字コードは以下のとおりです。
  • 0 S -- 文字列
  • 0 I -- 整数(日付と期間を表すことができます)
  • 0 N -- NULL
たとえば、spell メソッドが以下のように定義されているとします。
cr::DoStuff(int in_one, string in_two, string in_three);
この場合、以下のように呼び出します。
callServerMethod("DoStuff", "cr", "ISS", [3, "a string", "another one"]);
このメソッドは、CA の開発およびサービス部門がカスタマイズに使用するもので、一般のサイトでの使用はお勧めしません。
戻り値
メッセージ コンポーネントがそれぞれの XML エレメントに返されます。 エレメントはすべて値を文字列で表したものです。 エレメントはサーバから戻ってきた順序になり、以下のフォーマットが使用されます。
<ServerReturn> <Paramx>
このコールはオブジェクト参照の戻り値をサポートしていません。 オブジェクト参照が spell メソッドによって返される場合、戻りデータは文字列「OBJECT」になります。 これはエラーではなく、その他のパラメータも返されます。
XML エレメント
タイプ
説明
<ServerReturn>
N/A
戻り値の <ParamX> エレメントを 0 個以上含む外部エレメントを示します。
<Paramx>
文字列
0 個以上を戻り値として示します。
x
は整数で、0 から始まり、エレメントが戻るごとに増加します。
check_bopsid を使用して BOPSID を検証できます。. これは、callServerMethod で以下のように呼び出されます。
String bopsid; // somehow gets populated with the BOPSID value String [] stuff = new String [] { bopsid }; String ret = usd.callServerMethod (sid, "check_bopsid", "api", "I", stuff);
BOPSID の検証が失敗した場合は、SOAP Fault が返されます。 検証が正常に終了した場合、戻り値は以下の形式の小さな XML 構造となります。
<ServerReturn> <Param0>CONTACT_PERSID</Param0> <Param1>SESSION_TYPE</Param1> <Param2>SESSION_ID</Param2> </ServerReturn>
  • CONTACT_PERSID
    検証済み/信頼できる連絡先の一意の固定 ID を定義します。 「cnt:<uuid>」という形式になります。
  • SESSION_TYPE
    BOPSID を生成したセッションのタイプを示す小さい整数 ID を定義します。 これは通常、インテグレータでは使用されません。
  • SESSION_ID
    オプションのセッション ID を定義します。 これは、BOPSID を生成したセッションの ID です。 設定される場合もあれば、設定されない場合もあります。 これは、ユーザが別の BOPSID によって CA SDM に「渡される」場合などに、CA SDM 内でユーザの論理セッションを管理するのに便利です。
BOPSID の検証が正常に終了した場合は、ログイン画面を省略して CA Support Automation にログインします。それ以外の場合は、CA Support Automation ログイン画面が表示されます。
createObject
createObject メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
ObjectType
文字列
作成するオブジェクトのタイプを指定します(majic ファクトリ名)。
attrVals
String[]
新規案件の初期属性値の設定に使用される名前と値のペアのシーケンスを指定します。
注:
ドット付きの名前は使用できません。
attributes
String[]
値を返す新規オブジェクトの属性名を配列で指定します。 ドット表記を使用することができます。 このフィールドが空の場合は、すべての属性値が返されます。
createObjectResult
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
newHandle
String Holder
返されたデータをキャプチャするための String Holder オブジェクトを指定します。 詳細については、以下の XML エレメントの戻り値のリストを参照してください。
説明
CA SDM オブジェクトを作成します。 コール元は、
attrVals
パラメータに必須フィールドを設定する必要があります。 ドット付きの名前は使用できません。
  • ObjectType
    オブジェクト タイプ(ファクトリ)の名前を指定します。
  • attrVals
    新規オブジェクトの初期化に使用される名前と値のペアの配列を指定します。 たとえば、以下の擬似コードは、連絡先を作成し、すべての属性値を含む <UDSObject> エレメントを返す方法を示しています。
    String [4] attrVals; attrVals[0] = "first_name"; // attribute name attrVals[1] = "Edgar"; attrVals[2] = "last_name"; attrVals[3] = "Martin"; string [0] emptyArray; CreateObject(sid, "cnt", attrVals, emptyArray, createObjectReturn, newHandle);
    このメソッドは、新規アセット、新規案件、新規リクエスト、および新規変更要求には使用しないでください。 これらのオブジェクト タイプに特化した createXXX() メソッドを使用してください。 このコメントは、ITIL 方式を使用している場合にも適用されます。構成アイテム、インシデント、および問題を作成するには、適切なメソッドを使用してください。
戻り値
新規オブジェクトのハンドル、および
attributes
パラメータで指定された属性値を含む <UDSObject> エレメント。
attributes
パラメータが空の場合、
すべての
属性値が返されます。 ListおよびLRELタイプは空のエレメントとして返されます。
XML エレメント
タイプ
説明
<createObjectResult>
N/A
ハンドルおよびリクエストされた属性値を含む、標準UDSObjectエレメントを示します。
<newHandle>
文字列
新規オブジェクトのハンドルを指定します
serverStatus
serverStatus メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
説明
CA SDM サーバのステータスが返されます。サーバが起動中か、またはシャットダウンしているかが示されます。
このメソッドは、サーバ上で迅速に実行されます。 このメソッドを定期的にコールすることにより、SID をアクティブに保つことができます。
戻り値
以下の値が返されます。
  • 1
    - Service Desk サーバが使用できないことを示します。
    注:
    1010 などの 0 以外のリターン コードはすべて、サーバが利用できないことを示します。
  • 0
    - Service Desk サーバが実行中であることを示します。
XML エレメント
タイプ
説明
<ServerStatus>
整数
サーバ ステータスに関連付けられた値(0 または 1)を示します。
updateObject
updateObject メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
objectHandle
文字列
更新する CA SDM オブジェクトのハンドルを指定します。
attrVals
String[]
更新する名前と値のペアを指定します。
attributes
String[]
値を返すオブジェクトの属性名を配列で指定します。 ドット表記を使用することができます。 このフィールドが空の場合は、すべての属性値が返されます。
説明
指定したオブジェクトの 1 つ以上の属性を更新します。
オブジェクトの値を設定するには、コール元が属性の名前と値のペアの一次元配列を渡します。 ペアの前半分は属性名で、後ろ半分は実際の値です。 ドット付きの名前は使用できません。
Pointer タイプの属性(たとえば、リクエストの顧客フィールド)を更新するには、値のハンドルを使用する必要があります。 Integer、Date、および Duration タイプの場合は、整数を文字列で表した値を渡します。
たとえば、新しい担当者、説明、および優先度でリクエストを更新するには、以下のような配列を使用します。
[0] - "assignee" [1] - "cnt:555A043EDDB36D4F97524F2496B35E75" (a contact Handle) [2] - "description" [3] - "My new description" [4] - "priority" [5] - "pri:38903" (a priority Handle)
何らかの理由で更新が失敗した場合は、操作全体が中止され、変更は発生しません。
タスクを更新する場合は、ステータスの値を属性配列の最後に設定します。
戻り値
更新されたオブジェクトのハンドルを含む <UDSObject> エレメント、および
attributes
パラメータで指定した属性の値。
attributes
パラメータが空の場合、
すべての
属性値が返されます。 ListおよびLRELタイプは空のエレメントとして返されます