BPD 関連リソース用の REST インターフェース - グローバル・チーム・リソース - GET メソッド

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

メソッドの呼び出し例

GET /rest/bpm/wle/v1/globalTeams[?filter={string}][&size={integer}][&globalTeamIds={string}]

パラメーター

オプション・パラメーター
名前値タイプ製品の機能詳細
Filter ストリング
グローバル・チームをフィルタリングし、指定されたフィルター条件に一致するチーム名のみを含めます。 フィルターでは大/小文字を区別しません。 デフォルトでは、このメソッドは、ユーザーがアクセス権限を持つすべてのグローバル・チームを返します。 例:「hiring*」は、名前が「hiring」で始まるすべてのチームを返します。
size 整数
返されるエンティティーの最大数を指定します。 この数値を指定しない場合は、代わりにデフォルト・サイズの 100 が使用されます。 限度は 999 です。
globalTeamID ストリング
オプション・パラメーター globalTeamIds は、チームのリストを受け取ります。 この呼び出しは、ユーザーがアクセスを許可されているチームのサブセットの (場合によっては空の) リストを返します。

要求の内容

なし

応答の内容

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

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

MIME タイプ: application/json


スキーマ
{"説明": "GlobalTeams",
   "type": "object",
   "Properties":
   { "teams":
     [
        {
             "teamId": {"タイプ": "ストリング",
                 "description": "このオブジェクトによって記述されるチームの ID。"
              },
              "teamName": {"タイプ": "ストリング",
                 "description": "このオブジェクトによって記述されるチームの名前。"
              },
             "processApp名前": {"type": "string",
                 "description": "このオブジェクトを所有するプロセス・アプリケーション名。"
              }
         }
      ]
   }
}
コンテンツの例
{
   "status":"200",
   "データ": {
      "teams":[
         {
            "teamId":"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
            "teamName":"Human Resources",
            "processAppName":"Hiring Sample"
         },
         {
            "teamId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
            "teamName":"GeneralManagers",
            "processAppName":"Hiring Sample"
         },
         {
            "teamId":"24.cd97937f-06ab-43cc-8067-17dea489fdb3",
            "teamName":"HiringManagers",
            "processAppName":"Hiring Sample"
         }
      ]
   }
}

MIME タイプ: application/xml


スキーマ
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/globalteam"
        elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:tns="http://rest.bpm.ibm.com/v1/data/globalteam"
        xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
        xmlns:common = "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 an team definition that represents a BPM Team.
    -->
    <complexType 名前 = "GlobalTeam">
        <complexContent>
            < 拡張 base= " pref :Data"> 
                <sequence>
                    <!-- 
                    チームの ID。
                    このフィールドは必須です。 
                    -->
                    < エレメント名 = "teamId" type = "string " />
                    <!-- 
                    The display name of the team. 
                    このフィールドは必須です。 
                    -->
                    < 要素名 = "teamName" type = "string " />
                    <!-- 
                    プロセス・アプリケーションの表示名。 
                    このフィールドは必須です。 
                    -->
                    < エレメント名 = "processAppName" type="string " />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
    <!-- 
        A list of team definitions. 
    -->
    <complexType name= "GlobalTeamリスト ">
        <complexContent>
            < 拡張 base= " pref :Data">
                <sequence>
                    < element name = "teams "type="tns:GlobalTeam" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
               
   	< 要素名 = "GlobalTeam" type="tns:GlobalTeam" />    	
   	< element name= "GlobalTeamList" type="tns:GlobalTeamリスト " />    	
        
</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/team' xsi:type = 'ug:TeamDefinitions'>
    < チーム>
      <teamId>24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e</teamId>
      <teamName> 人事 </teamName>
      <processApp「名前」>「雇用サンプル」</processApp「名前」>
    </チーム>
    < チーム>
      <teamId>24.eb30156e-52c8-4ec5-9be6-02290d02f827</teamId>
      <teamName>GeneralManagers</teamName>
      <processApp「名前」>「雇用サンプル」</processApp「名前」>
    </チーム>
    < チーム>
      <teamId>24.cd97937f-06ab-43cc-8067-17dea489fdb3</teamId>
      <teamName>HiringManagers</teamName>
      <processApp「名前」>「雇用サンプル」</processApp「名前」>
    </チーム>
  </data>
< /bpm:ResponseData>

エラー応答の内容

詳細なエラー情報。

デフォルトのコンテンツ・タイプは次のとおりです。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>

状況コード

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

使用開始

8.5.7

親トピック: GlobalTeam リソース