getPolicyInfo

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
getPolicyInfo メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
説明
現在の CA SDM Web サービス セッションを制御および管理しているアクセス ポリシーに関する情報が返されます。
戻り値
以下の XML 文字列が返されます。
XML エレメント
タイプ
説明
<SAPolicy>
N/A
このアクセス ポリシーの詳細情報および関連する問題タイプを示します。
<SAPolicy> の内容は以下のとおりです。
<SAPolicy> <Name> name of policy </Name> <Code> policy code </Code> <ContactName> policy proxy contact's combo name </ContactName> <ContactHandle> handle of policy's contact </ContactHandle> <Access> <TicketCreation> limitation </TicketCreation> <ObjectCreation> limitation </ObjectCreation> <ObjectUpdate> limitation </ObjectUpdate> <Attachments> limitation </Attachments> <Queries> limitation </Queries> <Knowledge> limitation </Knowledge> </Access> <ProblemTypes> (zero or more <ProblemType> elements) <ProblemType> <Code>code of a problem type </Code> <Status>active or inactive </Status> </ProblemType> </ProblemTypes> </SAPolicy>
getTaskListValues
getTaskListValues メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
objectHandle
文字列
案件または変更要求のオブジェクト ハンドルを指定します。
attributes
文字列
値をフェッチする属性名の配列を指定します。 ドット付きの属性を使用することができます。 これを空白にすると、すべての属性がフェッチされます。
説明
指定した案件または変更要求に関連付けられているすべてのタスクの値が返されます。
これは扱いやすいメソッドです。 doSelect() を使用して同じリストを取得することができます。
戻り値
このメソッドは、以下の戻り値を返します。
XML エレメント
タイプ
説明
<UDSObjectList>
N/A
0 個以上の <UDSObject> エレメントを含む外部エレメントを示します。 各 <UDSObject> ノードは 1 つのタスクを表します。 ノードはタスクの「sequence」属性の順序で並んでいます。
getValidTaskTransitions
getValidTaskTransitions メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
taskHandle
文字列
案件または変更要求のワークフロー タスクのハンドルを指定します。
attributes
String[]
「tskstat」オブジェクトからフェッチする属性名を指定します。 このフィールドが空の場合は、値に基づく属性がすべて返されます。
説明
特定のタスクの「status」属性に使用可能な値がすべて返されます。 タスクに設定可能なステータス コードはいくつかの要因によって決定されます。たとえば、タスクの現在のステータス、管理者が設定した制限などです。
taskHandle
には、変更要求または案件が所有するタスクを指定できます。 返されるオブジェクトは、両方のタスクに使用されたタスク ステータス(「tskstat」)オブジェクトです。
タスクに設定可能な 0 個以上のステータス オブジェクトが返されます。
戻り値
このメソッドは、以下の戻り値を返します。
XML エレメント
タイプ
説明
<UDSObjectList>
N/A
リクエストされた属性値、および 0 個以上の <UDSObject> エレメントを含む外部エレメントを示します。
getValidTransitions
getValidTransitions メソッドでは、チケットの遷移をリストすることができます。
以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
handle
文字列
チケット ハンドルまたはステータス ハンドルを指定します。 チケット ハンドルが提供されると、メソッドはチケットの現在のステータスの有効な遷移を取得します。
ticketFactory
文字列
チケットのファクトリを指定します。 有効な値は、それぞれ、リクエストでは「cr」、インシデントでは「in」、問題では「pr」、変更要求では「chg」、および案件では「iss」のみです。
説明
チケットのステータスに対して有効なすべての遷移値が返されます。 管理者は、すべてのチケット タイプに対して、有効なステータス遷移を設定することができます。
handle および ticketFactory に対して渡された値に応じて、0 個以上のリクエスト遷移/インシデント遷移/問題遷移/変更遷移/案件遷移のオブジェクトが返されます。 返されたオブジェクトの数が 0 の場合、チケットのステータスに遷移はありません。
戻り値
このメソッドは、以下の戻り値を返します。
XML エレメント
タイプ
説明
<UDSObjectList>
N/A
0 個以上の <UDSObject> エレメントを含む外部エレメントを示します。
getDependentAttrControls
getDependentAttrControls メソッドを使用することで、ステータス レコード(チケットの現在のステータスまたは任意のステータス レコードのどちらか)のロックされた属性および必須の属性をリストすることができます。 この時点で、サポートされている属性は、Status 属性のみです。 attrVals パラメータが空として渡された場合、メソッドは、チケットの現在のステータスの従属属性を返します(有効なハンドルが使用されることを前提とします)。 それ以外の場合は、attrVals パラメータを使用して、任意のステータス レコードの従属属性を要求することができます。
以下のように、attrVals パラメータ構文を入力します。
  • 最初の項目には、「status」という用語を指定します。
  • 2 つ目の項目には、ステータス レコードのコード(たとえば、WIP)を指定します。
以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
handle
文字列
チケットのハンドルを指定します。
attrVals
文字列
このメソッドではチケット属性の名前/値のペアを指定して、その従属属性コントロールを取得します。
説明
チケットの[ステータス]フィールドに対する有効なすべての従属属性コントロールが返されます。 管理者は、属性制約を設定できます。
指定された値に応じて、0 個以上の属性コントロール オブジェクトが返されます。 返されたオブジェクトの数が 0 の場合、オブジェクトの属性制約はありません。
戻り値
以下の値が返されます。
XML エレメント
タイプ
説明
<UDSObjectList>
N/A
0 個以上の <UDSObject> エレメントを含む外部エレメントを示します。
getHandleForUserid
getHandleForUserid メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
userID
文字列
クエリ対象のユーザ ID を指定します。
説明
ユーザ ID で表される連絡先の固定ハンドルを返します。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
<Handle>
文字列
連絡先のハンドルを示します。
getAccessTypeForContact
getAccessTypeForContact メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
ContactHandle
文字列
クエリ対象の連絡先のハンドルを指定します。
説明
連絡先のアクセス タイプのハンドルを返します。
すべての連絡先には、アクセス タイプ オブジェクトが割り当てられています。これによって、連絡先の許可およびセキュリティが定義されています。 連絡先の access_type フィールドは必須ではないことに注意してください。 このため、オブジェクトを割り当てられていない連絡先のデフォルトとして 1 つのアクセス タイプが設定されています。
このメソッドは、連絡先に直接割り当てられたアクセス タイプ(連絡先レコードで access_type フィールドが指す情報)、またはデフォルトを返します。 getObjectValues() や getListValues() などの典型的な値のメソッドでは、正しいアクセス タイプが返されない場合があります。このため、これらのメソッドは連絡先のアクセス タイプを取得するのに適しません。
戻り値
アクセス タイプ オブジェクトの文字列ハンドル。
getContact
getContact メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
文字列
ログインにより取得したセッションを指定します。
contactId
文字列
取得する連絡先の一意の ID を指定します。contactId は文字列形式の UUID です。
説明
すべての連絡先の情報を取得します。
戻り値
<UDSObject> ノード。このノードには、以下の <Attributes> 子ノードの一部を使用して連絡先を説明する <UDSObject> ノードが含まれています。
XML エレメントの値
タイプ
説明
contactid
文字列
連絡先の一意の ID を指定します。contactId は文字列形式の UUID です。
userid
文字列
連絡先のユーザ名を示します。
last_name
文字列
連絡先の姓を示します。
first_name
文字列
連絡先の名を示します。
middle_name
文字列
連絡先のミドル ネームを示します。
location
文字列
連絡先のロケーションを示します。
dept
文字列
連絡先の部門を示します。
organization
文字列
連絡先の組織を示します。
email_address
文字列
連絡先の電子メール アドレスを示します。
pemail_address
文字列
連絡先のその他の電子メール アドレスを示します。
phone_number
文字列
連絡先の電話番号を示します。
alt_phone
文字列
連絡先のその他の電話番号を示します。
address1
文字列
連絡先の住所を示します。
address2
文字列
連絡先のその他の住所を示します。
city
文字列
連絡先の市町村を示します。
state
文字列
連絡先の都道府県を示します。
zip
文字列
連絡先の郵便番号を示します。
country
文字列
連絡先の国を示します。
delete_flag
整数
連絡先がアクティブかどうかを示します。
0
- アクティブ
1
- 非アクティブ
findContacts
findContactsメソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
userName
文字列
このユーザ名を持つ連絡先だけが返されます。 パーセント(%)記号を使用してワイルドカード検索ができます。
たとえば、Smi で始まるユーザ名を持つすべての連絡先を検索する場合は、Smi% と指定します。
lastName
文字列
この姓を持つ連絡先だけが返されます。 パーセント(%)記号を使用してワイルドカード検索ができます。
firstName
文字列
この名を持つ連絡先だけが返されます。 パーセント(%)記号を使用してワイルドカード検索ができます。
email
文字列
この電子メール アドレスを持つ連絡先だけが返されます。 パーセント(%)記号を使用してワイルドカード検索ができます。
accessType
文字列
このアクセス タイプを持つ連絡先だけが返されます。 カンマ区切りで複数の役割を指定できます。 以下の値を指定します。
10002 - 管理
10004 - 顧客
10005 - 従業員
10009 - IT スタッフ
10013 - ナレッジ管理
10014 - プロセス管理
10010 - サービス デスク管理
10008 - サービス デスク スタッフ
10020 - ベンダー スタッフ
inactiveFlag
整数
非アクティブまたはアクティブな連絡先だけが返されます。 以下の値を指定します。
0(アクティブ)
-999(すべて)
その他(非アクティブ)
説明
連絡先のリストを取得します。
戻り値
<UDSObjectList> ノード。ノード内に、以下の <Attributes> 子ノードを使用して連絡先を説明する0個以上の <UDSObject> ノードを含みます。
XML エレメントの値
タイプ
説明
id
UUID
連絡先の一意の ID を示します。
userid
文字列
連絡先のユーザ名を示します。
last_name
文字列
連絡先の姓を示します。
first_name
文字列
連絡先の名を示します。
access_type
整数
連絡先の役割 ID を示します。
delete_flag
整数
連絡先がアクティブか非アクティブかを示します。
0 - アクティブ
1 - 非アクティブ