IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/assets/compare?srcSnapshotId={string}&destBranchId={string}
| Name | Value Type | Description |
|---|---|---|
| srcSnapshotId | string | The ID of the snapshot associated with the source of the comparison.
|
| destBranchId | string | The ID of the branch associated with the destination track tip for the comparison.
|
None
The default content type is application/json.
{
"status":"200",
"data":{
{
"type": "string", "description": "The type name of the asset.",
"enum":
[
"ProjectDefaults",
"BPD",
"Human Service,
"SCA Service",
"Integration Service",
"Rule Service",
"General System Service",
"VariableType",
"Participant,
"ExternalActivity",
"EPV",
"TimingInterval",
"TrackingGroup",
"SLA",
"UCA",
"WebService"
]
}:
[
{
"poId":{"type": "string", "description": "The persistent object ID of the asset."},
"poVersionId": {"type": "string", "description": "The persistent object version ID of the asset."},
"tags":[{"type": "string", "description": "The tag of the asset."}],
"name":{"type": "string", "description": "The name of the asset."},
"last_modified_by_userId":{"type": "long", "description": "The user ID of the last modifier on the asset."},
"last_modified_by_userName":{"type": "string", "description": "The user name of the last modifier on the asset."},
"last_modified":{"type": "long", "description": "The last modified date of the asset."},
"status": {"type": "string", "description": "The comparison status type.",
"enum":
[
"NoChange",
"Conflict",
"Updated",
"New"
]
},
"isNewerVersion": {"type": "boolean", "description": "Indicates whether the persistent object version of this asset in the source is new than target."},
"hasBrokenDep": {"type": "boolean", "description": "Indicates whether there is any dependency of this asset is reachable or not."},
"dependencies":[
{
"poId":{"type": "string", "description": "The persistent object ID of the object that this asset depends one."},
"name":{"type": "string", "description": "The name of the object that this asset depends one."},
"status": {"type": "string", "description": "The comparison status type.",
"enum":
[
"NoChange",
"Conflict",
"Updated",
"New"
]
},
"isNewerVersion": {"type": "boolean", "description": "Indicates whether the persistent object version of this dependency in the source is new than target."},
"isBrokenDep": {"type": "boolean", "description": "Indicates whether this dependency is reachable or not."},
"isExternal": {"type": "boolean", "description": "Indicates whether this dependency is in the external toolkit snapshot or not."}
}
]
}
]
}
}
Note:
1. "SCA Service" is also called "advanced integration service"
2. "Rule Service" is also called "decision service"
3. "BPD" is "business process definition"
4. "VariableType" is also called "business object"
5. "Participant" is "participant group"
6. "EPV" is "exposed process value"
7. "SLA" is "service level agreement"
8. "UCA" is "undercover agent"
{
"status":"200",
"data":{
"Human Service":[{
"poId":"1.7f854d48-db50-49fd-9229-929f7840394b",
"poVersionId":"5fe866a1-c3f1-4396-87ef-bc246b03a004",
"tags":[],
"dependencies":[{
"poId":"12.0b208895-bdb3-4e67-a402-af17a05858d2",
"name":"Requisition",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
"name":"Position",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
}
],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"GM Approval",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348332253
},
{
"poId":"1.808aeb01-c634-4d76-94fa-264acfe7857b",
"poVersionId":"46502001-7249-4af3-945b-9f612d7c44ed",
"tags":[],
"dependencies":[],
"status":"Updated",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"HR1",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320704030498
},
{
"poId":"1.551dd543-a770-4d6c-b0e0-1c9d61242e55",
"poVersionId":"3ead29fc-425b-47d5-b64f-b24eb83225f9",
"tags":[],
"dependencies":[{
"poId":"12.0b208895-bdb3-4e67-a402-af17a05858d2",
"name":"Requisition",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
"name":"Position",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
}
],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"Submit Requisition",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331691
}
],
"Participant":[{
"poId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"poVersionId":"ac82cd08-393e-46b1-9fab-306e5a3ebf7d",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"GeneralManagers",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331394
},
{
"poId":"24.cd97937f-06ab-43cc-8067-17dea489fdb3",
"poVersionId":"a05c183e-ef2f-4714-b9e6-f03e9742c592",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"HiringManagers",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331331
},
{
"poId":"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
"poVersionId":"16714570-6840-444b-a0b5-66768801dadc",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"HRManagers",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331238
}
],
"VariableType":[{
"poId":"12.f3a52cf9-83c9-4900-9730-1229d8b37b43",
"poVersionId":"6a6d8d99-7abf-46f3-9e0a-25f4784a6188",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"Person",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331535
},
{
"poId":"12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
"poVersionId":"21760260-7144-4ef2-b5d1-d1d435059cf1",
"tags":[],
"dependencies":[{
"poId":"12.f3a52cf9-83c9-4900-9730-1229d8b37b43",
"name":"Person",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
}
],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"Position",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331519
},
{
"poId":"12.0b208895-bdb3-4e67-a402-af17a05858d2",
"poVersionId":"a40333e0-979a-4d86-819d-7ac712364be9",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"Requisition",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348331488
}
],
"BPD":[{
"poId":"25.671ba705-8985-4467-a974-e8857d8006b8",
"poVersionId":"cfd671e1-c2bf-4114-b423-cd326a7d95f8",
"tags":[],
"dependencies":[{
"poId":"1.808aeb01-c634-4d76-94fa-264acfe7857b",
"name":"HR1",
"status":"Updated",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
}
],
"status":"Conflict",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"BPD1",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320704078592
},
{
"poId":"25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"poVersionId":"3b0a18f1-baae-402e-83d7-bc4c3f290cda",
"tags":[],
"dependencies":[{
"poId":"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
"name":"HRManagers",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"12.0b208895-bdb3-4e67-a402-af17a05858d2",
"name":"Requisition",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"name":"GeneralManagers",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
"name":"Position",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"24.cd97937f-06ab-43cc-8067-17dea489fdb3",
"name":"HiringManagers",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"1.7f854d48-db50-49fd-9229-929f7840394b",
"name":"GM Approval",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
},
{
"poId":"1.551dd543-a770-4d6c-b0e0-1c9d61242e55",
"name":"Submit Requisition",
"status":"NoChange",
"isNewerVersion":false,
"isBrokenDep":false,
"isExternal":false
}
],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"HR Open New Position",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348332456
}
],
"ProjectDefaults":[{
"poId":"63.4f12afdb-4ee4-4e74-b053-305c70e3a7b2",
"poVersionId":"4f49ba41-c0be-4957-a176-f58b2078779a",
"tags":[],
"dependencies":[],
"status":"NoChange",
"hasBrokenDep":false,
"isNewerVersion":false,
"name":"Process App Settings",
"last_modified_by_userId":1,
"last_modified_by_userName":"Internal TW Admin user",
"last_modified":1320348332597
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/assets"
elementFormDefault="unqualified"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/assets"
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="Asset">
<complexContent>
<extension base="pref:NamedElement">
<sequence>
<element name="description" type="string" />
<element name="richDescription" type="string" />
<element name="poId" type="string" />
<element name="poVersionId" type="string" />
<element name="last_modified_by_userId" type="long" />
<element name="last_modified_by_userName" type="string" />
<element name="last_modified" type="long" />
<element name="tags" type="string" maxOccurs="unbounded" />
<element name="fullDepIds" type="string" maxOccurs="unbounded" />
<element name="dependencies" type="tns:tDependency" maxOccurs="unbounded" />
<element name="status" type="tns:tPOVersionStatus" />
<element name="poType" type="string" />
<element name="existsInTarget" type="boolean" />
<element name="sameVersionId" type="boolean" />
<element name="hasBrokenDep" type="boolean" />
<element name="isNewerVersion" type="boolean" >
<annotation>
<documentation>Only applies when the status is "Updated"</documentation>
</annotation></element>
<element name="shared" type="boolean" >
<annotation>
<documentation>Only applies when the poType is "VariableType"</documentation>
</annotation></element>
<element name="eventType" type="tns:tEventType" >
<annotation>
<documentation>Only applies when the poType is "UCA"</documentation>
</annotation></element>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="tDependency">
<sequence>
<element name="poId" type="string" />
<element name="name" type="string" />
<element name="poType" type="string" />
<element name="status" type="tns:tPOVersionStatus" />
<element name="isNewerVersion" type="boolean" >
<annotation>
<documentation>Only applies when the status is "Updated"</documentation>
</annotation></element>
<element name="isBrokenDep" type="boolean" />
<element name="isExternal" type="boolean" />
</sequence>
</complexType>
<simpleType name="tPOVersionStatus">
<restriction base="string">
<enumeration value="NoChange"/>
<enumeration value="Conflict"/>
<enumeration value="Updated"/>
<enumeration value="New"/>
</restriction>
</simpleType>
<complexType name="tAssetIDList">
<sequence>
<element name="ids" type="string" maxOccurs="unbounded" minOccurs="1"/>
</sequence>
</complexType>
<simpleType name="tEventType">
<restriction base="string">
<enumeration value="Message" />
<enumeration value="Content" />
<enumeration value="Timer" />
</restriction>
</simpleType>
</schema>
The default content type is 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."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
8.0.0
Parent Topic: Asset Comparison List Resource