IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/snapshot/{snapshotId}/changehistory
None
None
The default content type is application/json.
{
"status":"200",
"data":{
"baseSnapshotId":{"type": "string", "description": "The ID of the previous named snapshot."},
"snapshotId":{"type": "string", "description": "The ID of the current named snapshot."},
"histories":
{"type": "{object}", "description": "The change histories grouped by the ID of the persistent object.",
{
{"type": "string", "description": "The ID of the persistent object."}:
{
"poSubType":{"type": "string", "description": "The service type, which only applies when the persistent object is a service.",
"enum":
[
"Human Service,
"SCA Service",
"Integration Service",
"Rule Service",
"General System Service
]
},
"changes":
[
{
"userName":{"type": "string", "description": "The name of the user who made the change on the persistent object."},
"actionType":{"type": "string", "description": "The type of the change.",
"enum":
[
"add",
"change",
"delete"
]
}
"modified_on":{"type": "long", "description": "The date of the modification.
It is a long value that the client needs to format based on the time zone."},
"branchId":{"type": "string", "description": "The ID of the branch where the change occurred."},
"branchName":{"type": "string", "description": "The name of the branch where the change occurred."},
"branchAcronym":{"type": "string", "description": "The short name of the branch where the change occurred."}
}
],
"name":{"type": "string", "description": "The latest name of the persistent object up to the current snapshot."}
}
}
}
}
}
{
"status":"200",
"data":{
"snapshotIds":["2064.af2ea748-b6e6-4c85-a9eb-49ed08c2cd7e"
],
"baseSnapshotId":"2064.088c3f8f-16d1-41e0-a058-68905dd5973a",
"histories":{
"1.30397b90-a06d-4970-8f0c-ba8058c1271b":{
"poSubType":"Installation Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":" Installation Service"
},
"63.4f12afdb-4ee4-4e74-b053-305c70e3a7b2":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Process App Settings"
},
"1.f388ec60-d401-42bc-ab3e-a1ffcfe169df":{
"poSubType":"General System Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"gss1"
},
"1.551dd543-a770-4d6c-b0e0-1c9d61242e55":{
"poSubType":"Human Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Submit Requisition"
},
"12.f3a52cf9-83c9-4900-9730-1229d8b37b43":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Person"
},
"62.0c70aa8b-b6c0-4605-be8f-64a30fc672d5":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Environment Variables"
},
"15.5ddd66bf-514b-4dda-81fd-b8697f7f2dd8":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"tInterval1"
},
"1.7c5c7682-4fc6-484a-b41f-220e059fe1ec":{
"poSubType":"Rule Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ds1"
},
"24.eb30156e-52c8-4ec5-9be6-02290d02f827":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"GeneralManagers"
},
"12.0ea493a3-08b7-4456-84be-443c8d41bc8b":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Position"
},
"1.0eedcaad-6794-477e-82d9-844fe0bf1e24":{
"poSubType":"Integration Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"intService1"
},
"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"HRManagers"
},
"12.0b208895-bdb3-4e67-a402-af17a05858d2":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"Requisition"
},
"1.dbc86c13-0997-4147-8662-32447f68eead":{
"poSubType":"SCA Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ais"
},
"49.6b90bed2-7398-45c4-8719-f3f9a663f537":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"KPI1"
},
"4.a74773be-b12b-4002-96c9-dcb7b45b6eb5":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ua1"
},
"21.036ef80a-9b9c-4eb9-81f9-9ece98640f39":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"epv1"
},
"7.71b8a577-a46b-4608-aa7f-4d2ccee6a8c9":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ws1"
},
"4.0270755f-7202-486c-ab57-83741bf06fff":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ua2"
},
"47.fa427274-071e-4192-b43c-d115f536f60b":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"sla1"
},
"60.f89ab41e-7a91-4054-a8ec-08066fa6c5da":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"ei1"
},
"14.96205756-2698-4a58-80e4-406e6900d4e4":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"add",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"tGroup1"
},
"24.cd97937f-06ab-43cc-8067-17dea489fdb3":{
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"HiringManagers"
},
"1.7f854d48-db50-49fd-9229-929f7840394b":{
"poSubType":"Human Service",
"changes":[{
"userName":"Internal TW Admin user",
"actionType":"change",
"modified_on":1316830087300,
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"branchName":null,
"branchAcronym":null
}
],
"name":"GM Approval"
}
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/snapshot"
elementFormDefault="unqualified"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/snapshot"
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="SnapshotType">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="snapshotId" type="string"/>
<element name="seq_num" type="decimal"/>
<element name="name" type="string"/>
<element name="desc" type="string"/>
<element name="richDesc" type="string"/>
<element name="createdBy_userId" type="long"/>
<element name="createdBy_userName" type="string"/>
<element name="created_on" type="long"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="tBranchSnapshots">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="branchId" type="string"/>
<element name="name" type="string"/>
<element name="snapshots" type="tns:SnapshotType" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="tProjectSnapshots">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="branches" type="tns:tBranchSnapshots" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="tBranch">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="branchId" type="string"/>
<element name="name" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="tProjectBranches">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="branches" type="tns:tBranch" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="POHistory">
<annotation>
<documentation>poName attribute will be set to the latest one in all changes. </documentation>
</annotation>
<complexContent>
<extension base="pref:NamedElement">
<sequence>
<element name="poId" type="string" />
<element name="poSubType" type="string" />
<element name="changes" type="tns:ChangeItem"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="ChangeItem">
<annotation>
<documentation>branchId will be only set when compare two branches. poName will be set if it is not same as the latest one.</documentation>
</annotation>
<complexContent>
<extension base="pref:NamedElement">
<sequence>
<element name="modified_on" type="long"/>
<element name="userName" type="string"/>
<element name="actionType" type="string"/>
</sequence>
<attribute name="branchId" type="string" use="optional" />
<attribute name="branchName" type="string" use="optional" />
<attribute name="branchAcronym" type="string" use="optional" />
</extension>
</complexContent>
</complexType>
<complexType name="tSnapshotDelta">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="snapshotIds" type="string" maxOccurs="2" minOccurs="1"/>
<element name="baseSnapshotId" type="string"/>
<element name="histories" type="cmn:Map"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data" xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception"> <status>200</status> <data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:snap="http://rest.bpm.ibm.com/v1/data/snapshot" xsi:type="snap:tSnapshotDelta"> <snapshotIds>2064.bc97a55f-f158-40f3-8d8f-b9915a0dcc0d</snapshotIds> <baseSnapshotId>2064.af2ea748-b6e6-4c85-a9eb-49ed08c2cd7e</baseSnapshotId> <histories> <item key="60.f89ab41e-7a91-4054-a8ec-08066fa6c5da"> <value xsi:type="snap:POHistory"> <name>ei1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094705327</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="21.036ef80a-9b9c-4eb9-81f9-9ece98640f39"> <value xsi:type="snap:POHistory"> <name>epv1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094818391</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094827594</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="25.c904b3b1-afc1-4698-bf5a-a20892c20275"> <value xsi:type="snap:POHistory"> <name>HR Open New Position</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094916376</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="47.fa427274-071e-4192-b43c-d115f536f60b"> <value xsi:type="snap:POHistory"> <name>sla1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094783172</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094789843</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094852688</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094916376</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="14.96205756-2698-4a58-80e4-406e6900d4e4"> <value xsi:type="snap:POHistory"> <name>tGroup1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094875000</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="15.5ddd66bf-514b-4dda-81fd-b8697f7f2dd8"> <value xsi:type="snap:POHistory"> <name>tInterval1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094984220</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> <item key="4.a74773be-b12b-4002-96c9-dcb7b45b6eb5"> <value xsi:type="snap:POHistory"> <name>ua1</name> <changes branchId="2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e"> <modified_on>1317094729546</modified_on> <userName>Internal TW Admin user</userName> <actionType>change</actionType> </changes> </value> </item> </histories> </data> </bpm:ResponseData>
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. |
7.5.1
Parent Topic: Snapshot Change History Resource