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

このメソッドを使用して、現在フォロー中のインスタンスのリストを取得します。

メソッドの呼び出し例

GET /rest/bpm/wle/v1/social/instances/following

パラメーター

なし

要求の内容

なし

応答の内容

フォロー中インスタンスの検索結果 (SearchDetails complexType)。

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

MIME タイプ: application/json


スキーマ
{  "description": "WLE Search Details", 
   "type": "object",
   "Properties":
   { 
      "data": {"type": "[object]",
         "description": "This field contains a list of zero or more Map objects.  Each Map object represents a single row in the search result data and contains a key/value pair for each column of data within the row."
      },
      "firstColumnSort": {"type": "string",
         "description": "The primary sort column."
      },
      "secondColumnSort": {"type": "string",
         "description": "The secondary sort column."
      },
      "organization": {"type": "string",
         "description": "A string which indicates how the search results are organized: 'byTask', 'byInstance'."
      },
      "autoColumns": {"type": "[string]",
         "description": "A list of zero or more names of columns that were automatically added to the search results."
      },
      "offset": {"type": "integer",
         "description": "The offset value that was specified on the original request. This value represents the index (within the overall query result set) of the first item being returned"
      },
      "size": {"type": "integer",
         "description": "The number of items being returned. System configuration default will be used if size is not specified or set to zero."
      },
      "requestedSize": {"type": "integer",
         "description": "The number of items requested in the original request"
      },
      "totalCount": {"type": "integer",
         "description": "Total number of results.  This value will be the same as offset if number of result is less or equal to the offset value."
      }
   }
}
コンテンツの例
{
    status:"200",
    データ: {
        データ: [
            {
                taskAssignedTo:{
                    type:"User",
                    who:"tw_admin"
                },
                bpdName:"HR Open New Position",
                instanceCreateDate:"2012-01-09T14:57:52Z",
                instanceDueDate:"2012-01-23T14:57:52Z",
                instanceId:3,
                instanceModifyDate:"2012-01-09T14:58:01Z",
                instanceName:"Employee Requisition for (3)",
                instanceStatus:"Terminated",
                taskAttachedExtActivityRef:null,
                taskAttachedInfoPathFormRef:null,
                taskDueDate:"2012-01-09T20:47:59Z",
                taskId:88,
                taskPriority:"Normal",
                taskStatus:"Followed",
                taskSubject:"Following Employee Requisition for (3)"
            }
        ],
        firstColumnSort:"instanceDueDate",
        secondColumnSort:"taskPriority",
        organization:"byTask",
        autoColumns:[
            "instanceId",
            "taskAssignedTo",
            "taskAttachedExtActivityRef",
            "taskAttachedInfoPathFormRef",
            "taskId",
            "taskStatus"
        ]
    }
}

MIME タイプ: application/xml


スキーマ
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/search"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" 
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/search"
	xmlns:common="http://rest.bpm.ibm.com/v1/data/common" 
	xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root">
    
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />
    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />

    <!--
	This type is used to return metadata related to searches.
    -->
    <complexType name= "SearchMeta結果 ">
	<complexContent>
	    < 拡張 base= " pref :Data">
		<sequence>

		    <!-- 
			 A list of strings that represent the requested metadata.
			 This could be a list of all possible task status values,
			 a list of all possible priority values, etc.
			 The data returned in this structure will depend on the
			 type of metadata requested.
		    -->
		    < 要素名 = "result "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
		  
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <!--
	This type is used to return metadata related to a search,
	when the requested type of metadata is specified as "savedSearch".
    -->
    <complexType name= "SearchMetaTypedResult">
	<complexContent>
	    < 拡張 base= " pref :Data">
		<sequence>

		    <!-- 
			 This field represents a list of zero or more saved searches.
		    -->
		    < element name = "result "type="tns:TypedString" minOccurs= "0 " maxOccurs= "unbounded" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!--
	This type models an element of type string which also contains
	a string attribute named "type".
	This type is used to represent a saved search, where the 
	element value contains the name of the saved search,
	and the "type" attribute indicates whether the saved search
	is for tasks or processes.
    -->
    <complexType name= "TypedString">
	<simpleContent>
	    < extension base="string">
		< 属性名 = "type "type = "string" />
	    </extension>
	</simpleContent>
    </complexType>

    <!-- 
	This type contains the results of performing a search. 
    --> 
    <complexType name= "SearchDetails">
	<complexContent>
	    < 拡張 base= " pref :Data">
		<sequence>

			<!-- 
				This field contains a list of zero or more Map objects.
				Each Map object represents a single row in the search result data,
				and contains a key/value pair for each column of data within the row.
			-->
			<element name="data" type="common:Map" minOccurs="0"
				maxOccurs="unbounded" />

			<! -- 1 次ソート列の名前 -->
			< element name= "firstColumnSort" type="string " />

			<! -- 2 次ソート列の名前 -->
			< element name= "secondColumnソート" type="string " />

			<!-- 
				A string which indicates how the search results are organized.
				This will be set to "byTask" or "byInstance".
			-->
			< element name = "organization "type = "string" /> (エレメント名 = "organization "type = "string" />)

			<! -- 照会に自動的に追加された列のリスト -->
			<element name="autoColumns" type="string" minOccurs="0"
				maxOccurs="unbounded" />
				
			<! -- 戻された結果の索引の開始 -->
			< element name = "offset "type = "int" /> (element name = "offset "type = "int" />)
			
			<! -- 返された結果の数 -->
            < element name = "size "type = "int" /> (エレメント名 = "size "タイプ = "int" />)
            
            <! -- 要求された結果の数 -->
            < エレメント名 = "requestedSize" type = "int " />
            
            <! -- 使用可能な結果の数 -->
            < エレメント名 = "totalCount" type = "int " />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    
    <!-- 
	This type represents the result from executing a performance query
    --> 
    <complexType name= "PerformanceSearch詳細 ">
	<complexContent>
	    < 拡張 base= " pref :Data">
		<sequence>

		    <!-- 
			 This field contains a list of zero or more Map objects.
			 Each Map object represents a single row in the search result data,
			 and contains a key/value pair for each column of data within the row.
		    -->
		    < element name="data "type="common :Map" minOccurs= "0 " maxOccurs= "unbounded" />

		    <! -- 集計 (ロールアップ) 結果 -->
		    < エレメント名 = "rollupResult" type="string " minOccurs= "0" />

		    <! -- 1 次ソート列 -->
		    < element name= "firstColumnSort" type="string " />

		    <! -- 2 次ソート列 -->
		    < element name= "secondColumnソート" type="string " />

		    <! -- 照会結果に自動的に追加された列の名前 -->
		    < エレメント名 = "autoColumns" type="string " minOccurs= "0" maxOccurs= "unbounded " />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	This type represents the result from performing a performance instance query.
    -->
    <complexType name= "PerformanceInstance詳細 ">
	<complexContent>
	    < 拡張 base= " pref :Data">
		<sequence>

		    <! -- 変更された追跡対象ビジネス・データ値のリスト -->
		    < element name = "data "type="tns:TrackedBusinessデータ" minOccurs= "0 " maxOccurs= "unbounded" />

		    <! -- 追跡対象の進行状況データのリスト -->
		    < element name = "progress "type="tns:TrackedProgress" minOccurs= "0 " maxOccurs= "unbounded" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>


    <!-- 
	 This type represents a tracked business data element that has changed.
    -->
    <complexType name= "TrackedBusinessデータ ">
	<sequence>

	    <! -- フィールドの値が変更されたときのタイム・スタンプ -->
	    < エレメント名 = "when "type="dateTime" />

	    <! -- このフィールドの値が変更されたステップの ID -->
	    < エレメント名 = "stepID" type="string " />

	    <! -- フィールドの値が変更されたステップの名前。-->
	    < エレメント名 = "stepName" type="string " />

	    <! -- 値が変更された追跡フィールドの名前 -->
	    < エレメント名 = "field "type="string" />

	    <! -- このフィールドの新しい値 -->
	    < element name = "value "type="anyType" />
	</sequence>
    </complexType>
    
    <!-- 
	This type represents tracked progress information for a step within a process instance
    -->
    <complexType 名前 = "TrackedProgress">
	<sequence>

	    <! -- このステップの ID -->
	    < エレメント名 = "stepID" type="string " />

	    <! -- このステップの名前 -->
	    < エレメント名 = "stepName" type="string " />

	    <! -- ステップに達したときのタイム・スタンプ -->
	    < element name = "仮名 "type="dateTime" />

	    <! -- ステップが開始されたときのタイム・スタンプ (タスクの場合) -->
	    < element name = "started "type="dateTime" minOccurs= "0" />

	    <! -- タスクを開始したユーザーのユーザー名 (それがタスクであった場合) -->
	    < エレメント名 = "startedWho" type="string " minOccurs= "0" />

	    <! -- ステップが終了したときのタイム・スタンプ (終了した場合) -->
	    < element name = "finished "type="dateTime" minOccurs= "0" />
	</sequence>
    </complexType>

</schema>
コンテンツの例
<?xml version="1.0" encoding="UTF-8"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data"
	xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception" xmlns:soc="http://rest.bpm.ibm.com/v1/data/social"
	xmlns:sys = "http://rest.bpm.ibm.com/v1/data/system" xmlns:ug = "http://rest.bpm.ibm.com/v1/data/usergroup">

	<status>200</status>
	<data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xmlns:srch = "http://rest.bpm.ibm.com/v1/data/search" xsi:type = "srch:SearchDetails">
		<data>
			< item key= "taskAssignedTo">
				<value xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common"
					xsi:type = "cmn:TaskAssignedTo">
					< type> ユーザー < /type>
					< who> tw_admin < /who>
				</値>
			</item>
			< 項目キー = "bpdName">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> HR Open New Position < /value>
			</item>
			< item key= "instanceCreate日付 ">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string">2012-01-09T14:57:52Z</value>
			</item>
			< item key= "instanceDue日付 ">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string">2012-01-23T14:57:52Z</value>
			</item>
			< 項目キー = "instanceId">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:decimal">3</value>
			</item>
			< item key= "instanceModify日付 ">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string">2012-01-09T14:58:01Z</value>
			</item>
			< 項目キー = "instanceName">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> 社員の求人ポジション (3) < /value>
			</item>
			< 項目キー = "instanceStatus">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> 終了 < /value>
			</item>
			< item key= "taskAttachedExtActivity参照" />
			< item key= "taskAttachedInfoPathFormRef" />
			< item key= "taskDue日付 ">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string">2012-01-09T20:47:59Z</value>
			</item>
			< 項目キー = "taskId">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:decimal">88</value>
			</item>
			< 項目キー = "taskPriority">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> 通常 < /value>
			</item>
			< 項目キー = "taskStatus">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> フォロー < /value>
			</item>
			< 項目キー = "taskSubject">
				< 値 xmlns:ns9="http://www.w3.org/2001/XMLSchema" xsi:type = "ns9:string"> Employee Requisition for (3) < /value>
			</item>
		</data>
		<firstColumnソート>instanceDue日付 </firstColumnソート>
		<secondColumnSort>taskPriority</secondColumnSort>
		< organization>byTask< /organization>
		<autoColumns>instanceId</autoColumns>
		<autoColumns>taskAssignedTo </autoColumns>
		<autoColumns>taskAttachedExtActivityRef </autoColumns>
		<autoColumns>taskAttachedInfoPathFormRef</autoColumns>
		<autoColumns>taskId</autoColumns>
		<autoColumns>taskStatus</autoColumns>
	</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正常終了。
401 認証が必要呼び出し側は、この要求に対して許可されていません。
406 Not Acceptable要求されたコンテンツ・タイプまたはコンテンツ・エンコード方式がサポートされていません。
500 内部サーバー・エラー重大な問題が発生しました。プログラマーの詳細が提供されます。

使用開始

8.0.0

親トピック: フォローされているインスタンス・リソース