BPD 関連リソース用の REST インターフェース-タスク・エキスパート・リソース-GET メソッド

タスクに対して識別され、 IBM Business Automation Workflow インストール済み環境に対して定義されているエキスパート・ユーザーに関する情報を取得します。

メソッドの呼び出し例

GET /rest/bpm/wle/v1/social/task/{taskId}/experts[?parts={string}]

パラメーター

オプション・パラメーター
名前値タイプ製品の機能詳細
パーツ ストリング
応答データのどの部分を返すかを示すストリング ( GroupDetailが返されるかどうか)。 以下の値を使用できます: all (デフォルト)、または none

要求の内容

なし

応答の内容

ExpertList -この応答オブジェクトはエキスパートのリストです。エキスパートのリストは、システム (systemIdentifiedUsers) によって識別されるユーザー、エキスパート参加者グループ (expertParticipantGroupUsers)、およびオプション部分 ( expertParticipantGroupDetails) です。これらは、 parts パラメーターを使用して応答オブジェクトに含めたり、応答オブジェクトから除外したりすることができます。 (ExpertList complexType).

デフォルトのコンテンツ・タイプは次のとおりです。application/json.

MIME タイプ: application/json


スキーマ
{"description": "ユーザー", 
   "type": "object",
   "Properties":
   {  
      "completed": {"type": "integer",
         "description": "このタスクがこのユーザーによって完了された、計算された回数。"
      },
      "avgHours": {"type": "double",
         "description": "このユーザーについてこのタスクを完了するために計算された平均時間。"
      },
      "userID": {"type": "integer",
         "description": "このオブジェクトによって記述されるユーザーのユーザー ID。"
      },
      "userName": {"タイプ": "ストリング",
         "description": "このオブジェクトによって記述されるユーザーのユーザー名。",
      },
      "fullName": {"type": "string",
         "description": "このオブジェクトによって記述されるユーザーのフルネーム。",
      },
      "isDisabled": {"type": "boolean",
         "description": " このユーザーが無効になっているかどうかを示します。 This field is set to false and cannot be changed."
      },
      "primaryGroup": {"type": "string",
         "description": "このユーザーに関連付けられている 1 次グループ。"
      },
      "emailAddress": {"タイプ": "ストリング",
         "description": "このユーザーに関連付けられた E メール・アドレス。"
      },
      "userPreferences":
      [
   	{"key": {"type": "string",
   	  	    "description": "ユーザー設定に関連付けられたキー。"
   		  },
   	  "値": {"type": "string",
   	  	    "description": "ユーザー設定に関連付けられた値。"
   		  }
   	}
      ],
      "memberships": {"type": "[string]",
      	"description": "ユーザーがメンバーになっているグループのリスト。"
      },
      "ワークロード": {"type": "integer",
         "description": "このユーザーに関連付けられているワークロード。"
      }
   }
}
コンテンツの例
{
	"status": "200",
	"データ":
		{
		"systemIdentifiedUsers": [{
				"completed": 2,
				"avgHours": 0,
				"userID": 0、
				"userName": "tw_admin",
				"fullName": "内部 TW 管理者ユーザー",
				"isDisabled": false、
				"primaryGroup": NULL、
				"emailAddress": NULL、
				"userPreferences": NULL、
				"tasksCollaboration": NULL、
				"memberships": NULL、
				"ワークロード": 0
			}],
		"expertParticipantGroupUsers": [{
				"avgHours": 0,
				"userID": 1、
				"userName": "tw_admin",
				"fullName": "内部 TW 管理者ユーザー",
				"isDisabled": false、
				"primaryGroup": NULL、
				"emailAddress": NULL、
				"userPreferences": {
					"ロケール": "en"
									},
				"tasksCollaboration": NULL、
				"memberships": NULL
			}],
		"expertParticipantGroupDetails": {
				"groupID": 1303、
				"groupName": "エキスパート参加者グループ 1 v1_T_b653ff89-3206-4f8d-add5-e38c3fc82c7e.c736b70f-b151-4099-a921-a033a2a017b3",
				"displayName": "エキスパート参加者グループ 1 v1",
				"description": "エキスパート参加者グループ 1 v1",
				"members": NULL
			}
		}
}

MIME タイプ: application/xml


スキーマ
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/usergroup"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/usergroup"
	xmlns:data="http://rest.bpm.ibm.com/v1/data/root" 
	xmlns:cmn = "http://rest.bpm.ibm.com/v1/data/common">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />

    <!-- 
	 This type represents a user that has been defined to the IBM BPM installation.
    -->
    <complexType name="User">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- ユーザーの数字の ID -->
		    < エレメント名 = "userID" type = "long " />

		    <! -- ユーザーに関連付けられた英数字のユーザー名 -->
		    < エレメント名 = "userName" type = "string " />

		    <! -- ユーザーのフルネーム -->
		    < エレメント名 = "fullName" type="string " minOccurs= "0" />

		    <! -- このフィールドは、このユーザーが非アクティブ化されているかどうかを示します。 -->
		    < エレメント名 = "isDisabled" タイプ = "boolean" />

		    <! -- 未使用 -->
		    < エレメント名 = "primaryGroup" type="string " minOccurs= "0" />

		    <! -- 未使用 -->
		    < エレメント名 = "emailAddress" type="string " minOccurs= "0" />

		    <! -- このユーザーに関連付けられたユーザー設定 (拡張属性) のリスト -->
		    < エレメント名 = "userPreferences" type="cmn :Map " minOccurs= "0" />

		    <! -- ユーザーが管理を許可されているユーザー設定のリスト -->
		    < element name= "editableUserPreferences" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- ユーザーがコラボレートしているタスク (taskIds) のリスト -->
		    < element name= "tasksCollaboration" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- このユーザーが所属するグループのリスト -->
		    < エレメント名 = "memberships "type="string" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 This type represents a user with a workload defined to the IBM BPM installation.
    -->
    <complexType 名前 = "TeamMember">
	<complexContent>
	    < extension base="tns: User">
		<sequence>

		    <! -- ユーザーの数字の ID -->
		    < エレメント名 = "workload "type = "integer" />

		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <!-- 
	 This type represents a user with a workload defined to the IBM BPM installation.
    -->
    <complexType name="Expert ">
	<complexContent>
	    < extension base="tns:TeamMember">
		<sequence>

		    <! -- TODO これは何ですか? -->
		    < element name = "completed "type = "integer" />
		    
		    <! -- TODO これは何ですか? -->
		    < エレメント名 = "avgHours" type = "double " />		    

		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <!-- 
     This type represents an array of Experts
    -->
    <complexType name="Experts">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
	    		<! -- MAY CONTAIN -->
		    	< element name="Experts "type="tns: Expert" minOccurs= "0 " maxOccurs= "unbounded" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>	
    
   <!-- 
	 This type represents a list of expert users with a workload defined to the IBM BPM installation.
    -->
    <complexType name= "ExpertList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- システムがタスクのエキスパートとして識別するユーザーのグループ -->
		    < element name= "systemIdentifiedUsers" type="tns: Expert " maxOccurs= "unbounded" minOccurs= "0 " />
		    
		    <! -- タスクのエキスパート参加者グループに含まれるユーザーのグループ -->
		    < element name= "expertParticipantGroupUsers" type="tns: Expert " maxOccurs= "unbounded" minOccurs= "0 " />	

		    <! -- task expert 参加者グループ -->
		    < element name= "expertParticipantGroupDetails" type="tns: Group " />

		</sequence>
	    </extension>
	</complexContent>
    </complexType>    
    
    <!-- 
	 This type represents a user that has been defined to the IBM BPM installation.
    -->
    <complexType name= "UserPreferences">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- ユーザーの表示名 -->
		    < エレメント名 = "displayName" type = "string " />

		    <! -- ユーザーの「基本役割の説明 -->
		    < element name= "primaryRole説明" type="string " />

		    <! -- ユーザーのタスク E メール・アドレス -->
		    < element name= "taskEmailアドレス" type="string " />

		    <! -- ユーザーの電話番号 -->
		    < element name= "phoneNumber" type = "string " />
		    
		    <! -- ユーザーの番地 -->
		    < エレメント名 = "streetAddress" type = "string " />
		    
		    <! -- ユーザーの市区町村 -->
		    < element name = "city "type = "string" /> (エレメント名 = "city "タイプ = "string" />)
		    
		    <! -- ユーザーの状態 -->
		    < element name = "state "type = "string" /> (エレメント名 = "state "タイプ = "string" />)
		    
  		    <! -- ユーザーの国 -->
		    < element name = "country "type = "string" />
		    
		    <! -- そのユーザーの郵便番号-->
		    < element name= "postalCode" type = "string " />
		    
		    <! -- ユーザーのイメージ -->
		    < element name = "image "type = "string" /> (エレメント名 = "image "タイプ = "string" />)

		    <! -- ユーザーのツールバーの省略表示設定 -->
		    < エレメント名 = "toolbarCollapsed" type = "boolean" />			    		    		    
		</sequence>
	    </extension>
	</complexContent>
    </complexType>    

    <!--
	This type represents a group that has been defined to the IBM BPM installation.
    -->
    <complexType name="Group">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- グループの数字の ID -->
		    < エレメント名 = "groupID" type = "long " />

		    <! -- グループの英数字名 -->
		    < エレメント名 = "groupName" type = "string " />

		    <! -- グループに関連付けられた表示名 -->
		    < エレメント名 = "displayName" type = "string " />

		    <! -- グループに関連付けられた説明 -->
		    < エレメント名 = "description "type = "string" />

		    <! -- このグループが論理的に削除された場合の情報 -->
		    < element name = "deleted "type =" boolean " />

		    <! -- このグループのメンバーになっているユーザーのリスト -->
		    < element name = "members "type="string" maxOccurs= "unbounded " minOccurs= "0" />
		    
		    <! -- マネージャー・グループの英数字名 -->
		    < エレメント名 = "managerGroupName" type="string " minOccurs= "0" />		    
		</sequence>
	    </extension>
	</complexContent>
    </complexType>    
    
    <!-- 
	 This type represents a list of zero or more users that have been defined to the IBM BPM installation.
    -->
    <complexType name= "UserList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    < element name="users "type="tns: User" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 This type represents a list of zero or more user groups that have been defined to the IBM BPM installation.
    -->
    <complexType name= "GroupList">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    < element name="groups "type="tns: Group" maxOccurs= "unbounded " minOccurs= "0" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
   	< element name="User "type="tns: User" /> 
  	< element name= "TeamMember" type="tns:TeamMember" />
   	< element name="Expert "type="tns: エキスパート" />    	    
   	< element name="Experts "type="tns: Experts" />    	    
   	< element name= "UserPreferences" type="tns:UserPreferences" />
   	< element name="Group "type="tns: Group" />    	
   	< エレメント名 = "UserList" type="tns:UserList" />    	
   	< エレメント名 = "GroupList" type="tns:GroupList" />    	

</schema>
コンテンツの例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< bpm:ResponseData xmlns:bpm = 'http://rest.bpm.ibm.com/v1/data'>
  <status>200</status>
  < データ xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:ug = 'http://rest.bpm.ibm.com/v1/data/usergroup' xsi:type = "ug:ExpertList">
	<systemIdentifiedUsers>
		<userID>0</userID>
		<userName> tw_admin </userName>
		<fullName> 内部 TW 管理ユーザー </fullName>
		<isDisabled> false </isDisabled>
		<workload>0</workload>
		<completed>2</completed>
		<avgHours>0.0</avgHours>
	</systemIdentifiedUsers>
	<expertParticipantGroupUsers>
		<userID>1</userID>
		<userName> tw_admin </userName>
		<fullName> 内部 TW 管理ユーザー </fullName>
		<isDisabled> false </isDisabled>
		<userPreferences>
			< 項目キー = " ロケール ">
			< 値 xmlns:ns8="http://www.w3.org/2001/XMLSchema" xsi:type = "ns8:string"> en < /value>
			</item>
		</userPreferences>
		<avgHours>0.0</avgHours>
	</expertParticipantGroupUsers>
	<expertParticipantGroupDetails>
		<groupID>1303</groupID>
		<groupName> エキスパート参加者グループ 1 v1_T_b653ff89-3206-4f8d-add5-e38c3fc82c7e.c736b70f-b151-4099-a921-a033a2a017b3</groupName>
		<displayName> エキスパート参加者グループ 1 v1</displayName>
		< 説明> エキスパート参加者グループ 1 v1</description>
	</expertParticipantGroupDetails>
  </data>
< /bpm:ResponseData>

MIME タイプ: application/x-javascript

エラー応答の内容

詳細なエラー情報。

デフォルトのコンテンツ・タイプは次のとおりです。application/json.

MIME タイプ: application/json


スキーマ
{"description": "WLE エラー応答", 
   "type": "object",
   "Properties":
   {"status": {"タイプ": "ストリング",
         "description": "前の API 呼び出しの状況。"
      },
      "exceptionType": {"type": "string",
         "description": "例外に関連付けられたクラス名。"
      },
      "errorNumber": {"タイプ": "ストリング",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"タイプ": "ストリング",
         "description": "Message text of the exception."
      },
      "errorMessageパラメーター": {"type": ["string"], "optional": true,
         "description": "例外のメッセージ・テキスト・パラメーター。"
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "追加の例外詳細 (スタック・トレースなど)。"
      }
   }
} 

MIME タイプ: application/xml


スキーマ
<?xml version="1.0" encoding="UTF-8"?>
< スキーマ targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	このタイプはエラー応答を表します。
    -->    
    < element name= "RestRuntime例外 ">
	<complexType>
	    <sequence>
		< エレメント名 = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 このタイプには、例外に関連した詳細なエラー情報が含まれます。
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < エレメント名 = "status "type="string" />

	    <! -- これは例外の Java クラス名を指定します -->
	    < エレメント名 = "exceptionType" type="string " />

	    <! -- エラー・メッセージのメッセージ ID -->
	    < エレメント名 = "errorNumber" type="string " minOccurs= "0" />

	    <! -- 完全なエラー・メッセージ -->
	    < エレメント名 = "errorMessage" type="string " />

	    <! -- エラー・メッセージに挿入されたストリングのリスト -->
	    < element name= "errorMessageパラメーター" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 例外に関連付けられたスタック・トレース。
		 「server-stacktrace-enabled」プロパティーが指定されていない場合、これは省略されることに注意してください。
		 サーバーの 100Custom.xml ファイルで有効になっています。
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- 以前の応答。  バルク・コマンドが使用された場合に設定 -->
	    < element name = "responses "type="dat:BulkCommandResponses" minOccurs= "0"> < /element>

            < エレメント名 = "errorData" type="tns:ErrorData" minOccurs= "0" />
	</sequence>
    </complexType>

    <complexType name= "ErrorData">
        <sequence>
            < element name = "code "type = "string" /> (エレメント名 = "code "タイプ = "string" />)
            < element name = "data "type="string" minOccurs= "0 " />
        </sequence>
    </complexType>
    
</schema>

MIME タイプ: application/x-javascript

状況コード

このメソッドは、以下のいずれかの状況コードを返します。
コード製品の機能詳細
200 OK正常終了。
400 間違った要求パラメーターが有効でないか、欠落しています。
401 認証が必要呼び出し側は、この要求に対して許可されていません。
406 Not Acceptable要求されたコンテンツ・タイプまたはコンテンツ・エンコード方式がサポートされていません。
500 内部サーバー・エラー重大な問題が発生しました。プログラマーの詳細が提供されます。

使用開始

8.0.0

親トピック: タスク・エキスパート・リソース