BPD 関連リソース用の REST インターフェース-ユーザー・リソース-GET メソッド

IBM Business Automation Workflow インストール済み環境に定義されているユーザーに関する情報を取得します。

メソッドの呼び出し例

GET /rest/bpm/wle/v1/users[?filter={string}][&maxresult={integer}][&assignTaskidFilter={string}][&collabTaskidFilter={string}][&includeTaskExperts={boolean}][&sort={boolean}][&includeInternalMemberships={boolean}][&namesonly={boolean}][&parts={string}][&refreshUser={boolean}][&includeFilter={string}]

パラメーター

オプション・パラメーター
名前値タイプ製品の機能詳細
フィルター ストリング
1 つ以上のワイルドカードを使用して、返されるユーザーのリストをフィルターに掛けることができます。 例: tw_* は、名前が tw_で始まるすべてのユーザーを返します。
最大結果 整数
返されるユーザーの最大数。 filter パラメーターが指定され、 maxresult が指定されていない場合、 00Static.xml ファイルの user-list-limit-from-external-security-provider パラメーターの値に基づいて、リストのデフォルトは最大 20 になります。
assignTaskidフィルター ストリング
タスク ID。 このフィルターが定義されている場合、返されるユーザーのリストには、タスクを再割り当てできるユーザーのみが含まれます。
collabTaskidフィルター ストリング
タスク ID。 このフィルターが定義されている場合、タスクでコラボレーションできるユーザーのみが、返されるユーザーのリストに含まれます。
includeTaskエキスパート ブール値
パラメーターが falseに設定されている場合、 collabTaskIdFilter 値を使用する呼び出しには、返されるユーザー・リスト内のタスクのエキスパートは含まれません。 デフォルト値はtrueです。
ソート ブール値
ユーザーのリストをフルネームでソートするかどうか。 デフォルト値は trueです。
includeInternalのメンバーシップ ブール値
このパラメーターは、parts パラメーターが memberships または allである場合の、返されるメンバーシップの外観を制御します。 パラメーターが falseの場合は、ユーザーが属するグループの名前が返されます。 これらの名前は、必ずしも固有である必要はありません。 パラメーターが trueに設定されている場合、内部で生成された固有のグループ・メンバーシップ名が返されます。 この場合、返されるリストには、アーカイブされたスナップショットのグループ・メンバーシップも含まれます。 デフォルト値はtrueです。
名前のみ ブール値
このパラメーターを trueに設定すると、このメソッドのパフォーマンスを向上させるために、取得されるユーザーに関する情報が少なくなります。 デフォルト値はfalseです。
パーツ ストリング
応答データのどのパーツを返すかを示すストリング。 membershipsall (デフォルト)、または noneのいずれかの値を使用できます。
refreshUser ブール値
ユーザーを取得する前に、ユーザーのフルネームとグループ・メンバーシップをリフレッシュします。 この関数を使用できるのは、「ACTION_REFRESH_USER」アクション・ポリシーによって参照されるグループのメンバーのみです。 2016.09: リフレッシュにより、 IBM Business Automation Workflow データベース内のユーザーの状態も、ユーザー・レジストリー内のユーザーの可用性と同期化されます。 ユーザー・レジストリーから削除されたユーザーは、 IBM Business Automation Workflow データベースで非アクティブになります。 ユーザー・レジストリーで再アクティブ化されたユーザーは、 IBM Business Automation Workflow データベースでアクティブになります。
includeFilter ストリング
2016.09: アクティブ・ユーザーまたは非アクティブ・ユーザーのみを返す必要があることを示すストリング。 使用できる値は、 deactivatedOnly または activeOnlyです。 ユーザーのリストは、ユーザー・レジストリーから取得されるのではなく、 IBM Business Automation Workflow データベースから取得されます。 assignTaskidFilter パラメーターまたは collabTaskidFilter パラメーターが指定されている場合、 includeFilter パラメーターは、 includeTaskExperts パラメーターおよび maxresult パラメーターと組み合わせて機能します。 assignTaskidFilter パラメーターも collabTaskidFilter パラメーターも指定しない場合、 includeFilter パラメーターを maxresult パラメーターと一緒に使用することはできません。 includeFilter パラメーターは、パラメーター includeInternalMembershipsnamesonly、および refreshUserと一緒に使用することはできません。

要求の内容

なし

応答の内容

UserList - IBM Business Automation Workflow インストール済み環境に対して定義されているゼロ個以上のユーザーのリスト (UserList complexType)。

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

MIME タイプ: application/json


スキーマ
{"description": "UserList", 
   "type": "object",
   "Properties":
   {"ユーザー":
      [
         {  
	    "userID": {"type": "integer",
               "description": "このオブジェクトによって記述されるユーザーのユーザー ID。"
            },
            "userName": {"タイプ": "ストリング",
               "description": "このオブジェクトによって記述されるユーザーのユーザー名。",
            },
            "fullName": {"type": "string",
               "description": "このオブジェクトによって記述されるユーザーのフルネーム。",
            },
            "isDisabled": {"type": "boolean",
               "description": "このユーザーが無効になっているかどうかを示します。"
            },
            "primaryGroup": {"type": "string",
               "description": "このユーザーに関連付けられている 1 次グループ。"
            },
            "emailAddress": {"タイプ": "ストリング",
               "description": "このユーザーに関連付けられた E メール・アドレス。"
            },
            "userPreferences":
	    [
		{"key": {"type": "string",
		  	    "description": "ユーザー設定に関連付けられたキー。"
			  },
		  "値": {"type": "string",
		  	    "description": "ユーザー設定に関連付けられた値。"
			  }
		}
	    ],
	    "memberships": {"type": "[string]",
	    	"description": "ユーザーがメンバーになっているグループのリスト。"
	    }
         }
      ]
   }    
}
コンテンツの例
{
   "status":"200",
   "データ": {
      "ユーザー": [
         {
            "userID": 8
            "userName":"bpmAuthor",
            "fullName": "内部作成者ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{

            },
            "メンバシップ": [
               "tw_authors",
               "tw_allusers"、
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f",
               "プロセス Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
               "Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
            ]
         },
         {
            "userID": 1、
            "userName": "tw_admin",
            "fullName": "内部 TW 管理者ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{
               "ロケール": "en"
            },
            "メンバシップ": [
               "デバッグ",
               "tw_admins"、
               "tw_authors",
               "tw_portal_admins"、
               "tw_process_owners"、
               "tw_allusers"、
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
            ]
         },
         {
            "userID": 2、
            "userName": "tw_author",
            "fullName": "内部 TW 作成者ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{

            },
            "メンバシップ": [
               "tw_authors",
               "tw_allusers"、
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f",
               "プロセス Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
               "Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf",
            ]
         },
         {
            "userID": 6、
            "userName": "tw_portal_admin",
            "fullName": "内部 TW ポータル管理者ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{

            },
            "メンバシップ": [
               "tw_portal_admins"、
               "tw_allusers"、
            ]
         },
         {
            「userID」: 7
            "userName": "tw_runtime_server",
            "fullName": "内部ランタイム・ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{

            },
            "メンバシップ": [

            ]
         },
         {
            "userID": 3、
            "userName": "tw_user",
            "fullName": "内部 TW ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{
               "ロケール": "en"
            },
            "メンバシップ": [
               "tw_allusers"、
               "TWSecurityProviderユーザー"
            ]
         },
         {
            "userID": 4、
            "userName": "tw_webservice",
            "fullName": "匿名 WebService ユーザー",
            "isDisabled" :false、
            "primaryGroup" :null、
            "emailAddress": NULL、
            "userPreferences":{

            },
            "メンバシップ": [
               "tw_allusers"、
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426",
               "すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f",
            ]
         }
      ]
   }
}

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:UserList'>
    <users>
      <userID>8</userID>
      <userName>bpmAuthor</userName>
      <fullName> 内部作成者ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences />
      < memberships> tw_authors < /memberships>
      < memberships> tw_allusers < /memberships>
    </users>
    <users>
      <userID>1</userID>
      <userName> tw_admin </userName>
      <fullName> 内部 TW 管理ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences>
        < 項目キー = 'ロケール'>
          < 値 xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type = 'ns5:string'> en < /value>
        </item>
      </userPreferences>
      < memberships> デバッグ < /memberships>
      < memberships> tw_admins < /memberships>
      < memberships> tw_authors < /memberships>
      < memberships> tw_portal_admins < /memberships>
      < memberships> tw_process_owners < /memberships>
      < memberships> tw_allusers < /memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships>
    </users>
    <users>
      <userID>2</userID>
      <userName> tw_author </userName>
      <fullName> 内部 TW 作成者ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences />
      < memberships> tw_authors < /memberships>
      < memberships> tw_allusers < /memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
    </users>
    <users>
      <userID>6</userID>
      <userName> tw_portal_admin </userName>
      <fullName> 内部 TW ポータル管理者ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences />
      < memberships> tw_portal_admins < /memberships>
      < memberships> tw_allusers < /memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships>
      < memberships> プロセス Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
      <memberships>Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
    </users>
    <users>
      <userID>7</userID>
      <userName> tw_runtime_server </userName>
      <fullName> 内部ランタイム・ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences />
    </users>
    <users>
      <userID>3</userID>
      <userName> tw_user </userName>
      <fullName> 内部 TW ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences>
        < 項目キー = 'ロケール'>
          < 値 xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type = 'ns5:string'> en < /value>
        </item>
      </userPreferences>
      < memberships> tw_allusers < /memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_S_da7e4d23-78cb-4483-98ed-b9c238308a03.40551a86-bac6-474e-a666-85f9a8a83426</memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.36c07d6c-ad75-4a42-9675-95275f281c3f</memberships>
      < memberships> プロセス Owner_T_9a9f919e-6644-4592-b900-3eaa46838454.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
      <memberships>Managers_T_eca3397d-df4d-4ea6-a74e-22aaef303e3c.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
      < memberships> すべての Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.2e16e361-17b4-49c6-9092-66c6a4ffd8bf</memberships>
      < memberships>TWSecurityProviderUsers < /memberships>
    </users>
    <users>
      <userID>4</userID>
      <userName> tw_webservice </userName>
      <fullName> 匿名 WebService ユーザー </fullName>
      <isDisabled> false </isDisabled>
      <userPreferences />
      < memberships> tw_allusers < /memberships>
    </users>
  </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 内部サーバー・エラー重大な問題が発生しました。プログラマーの詳細が提供されます。

使用開始

7.5.0

親トピック: ユーザー・リソース