BPD 相關資源的 REST 介面-Tracking Group Resource-GET 方法 [已淘汰]

此功能已淘汰。 使用此方法，可以擷取與追蹤群組相關的詳細資訊。

方法呼叫範例

GET /rest/bpm/wle/v1/trackinggroup/{tgId}[?snapshotId={string}][&branchId={string}]

使用注意事項

參數

附註: 若要識別要使用的正確 Snapshot ，您必須指定其中一個 snapshotId 或 branchId 參數。
適用下列優先順序規則:
1) 如果指定 snapshotId 參數，則會使用該特定 Snapshot ，並忽略 branchId 參數。
2) 如果指定 branchId 參數，則會使用所指定分支 (追蹤) 的提示 (現行) Snapshot。
選用參數
名稱值類型說明
snapshotId 字串
與 Tracking Group 相關聯的 Snapshot ID。 您必須設定其中一個 snapshotId 或 branchId 參數。
branchId 字串
與 Tracking Group 相關聯的分支 ID。 您必須設定其中一個 snapshotId 或 branchId 參數。

要求內容

無

回應內容

與 TrackingGroup (TrackingGroup類型 complexType) 相關的詳細資訊。

預設內容類型為application/json.

MIME 類型 :application/json


綱目
{
    "status": "200" ，
    "data": {
        "tgId":{"type": "string", "description": "The ID of the tracking group."},
        "name":{"type": "string", "description": "The name of the tracking group."}，
        "enabled":{"type": "boolean"}，
        "desc":{"type": "string", "description": "The description of the tracking group."}，
				"externalUniqueId":{"type": "string", "description": "The external unique ID of the tracking group."}，                
        "variables": [{
                "name":{"type": "string", "description": "The name of the variable."}，
                "variableId":{"type": "string", "description": "The ID of the variable."},
                "type": {"type": "string" ， "description": "The type of the variable." ，
                	"enum":
                	[
                		"string" ，
                		"datatime" ，
                		"數字"
                	]
                },
				        "externalUniqueId":{"type": "string", "description": "The external unique ID of the variable."}，                
                "desc":{"type": "string", "description": "The description of the variable."}
            }
        ]
    }
}
範例內容
{
    "status": "200" ，
    "data": {
        "tgId":"14.298c3209-1637-4f1f-a729-ec7529729592",
        "name": "TG1" ，
        "enabled" :true ，
        "desc": "My Test Tracking Group" ，
        "externalUniqueId": "P36e567388231" ，
        "variables": [{
                "name":"NAME",
                "variableId":"17.a725c00b-0e5f-40ae-aa5f-d9dfd8eadb55",
                "externalUniqueId": "a40cb77388231" ，
                "type": "string",
                "desc": "name documentation"
            },
            {
                "name": "creationDate" ，
                "variableId":"17.79e1f666-3593-4ff7-860a-c3a9e0bdd553",
                "externalUniqueId": "q57dacd6c8231" ，
                "type": "datetime" ，
                "desc": "creationDate documentation"
            }
        ]
    }
}

MIME 類型 :application/xml


綱目
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/trackinggroup"
	elementForm預設值 = "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/trackinggroup" xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root"
	xmlns:cmn = "http://rest.bpm.ibm.com/v1/data/common">

	<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" />

	<complexType name="VariableType">
		<sequence>
			<element name="name" type="string" />
			<element name="variableId" type="string" />
			<element name="externalUniqueId" type="string" />
			<element name="type" type="string"/>
			<element name="desc" type="string" />
			<element name="richDesc" type="string" />
		</sequence>
	</complexType>

	<complexType name="TrackingGroupType">
		<complexContent>
			<extension base="pref:Data">
				<sequence>
					<element name="tgId" type="string" />
					<element name="name" type="string" />
					<element name="enabled" type="boolean" />
					<element name="desc" type="string" />
					<element name="richDesc" type="string" />
					<element name="externalUniqueId" type="string" />
					<element name="variables" type="tns:VariableType" maxOccurs="unbounded"/>
				</sequence>
			</extension>
		</complexContent>
	</complexType>

</schema>

錯誤回應內容

詳細錯誤資訊。

預設內容類型為application/json.

MIME 類型 :application/json


綱目
{"description": "WLE Error Response" ， 
   "type": "object",
   "properties":
   {"status": {"type": "string" ，
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string" ，
         "description": "The classname associated with the exception."
      },
      "errorNumber": {"type": "string" ，
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string" ，
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"] ， "optional": true ，
         "description": "Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object" ， "optional": true ，
         "description": "Additional exception details ， for example ， a stack trace."
      }
   }
}

狀態碼

此方法會傳回下列其中一個狀態碼:
代碼說明
200 正常
順利完成-傳回詳細報告。
400 不當的要求參數無效或遺漏。
404 找不到資源不存在。
406 不可接受不支援所要求的內容類型或內容編碼。
500 內部伺服器錯誤發生嚴重問題，提供程式設計師的詳細資料。

可用自

7.5.1

上層主題: 追蹤群組資源



意見回饋