IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/project/{projectId}/snapshots
None
None
The default content type is application/json.
{
"status":"200",
"data":
{
"branches":
[
{
"name":{"type": "string", "description": "The name of the branch."},
"branchId":{"type": "string", "description": "The ID of the branch."},
"snapshots":[
{
"snapshotId":{"type": "string", "description": "The ID of the snapshot."},
"name":{"type": "string", "description": "The name of the snapshot."},
"desc":{"type": "string", "description": "The description of the snapshot."},
"createdBy_userId":{"type": "long", "description": "The ID of the user who created the snapshot."},
"createdBy_userName":{"type": "long", "description": "The name of the user who created the snapshot."},
"created_on":{"type": "long", "description": "The snapshot creation date, which is a long value that the client needs to format based on the time zone."},
}
]
}
]
}
}
{
"status":"200",
"data":{
"branches":[{
"branchId":"2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e",
"name":"Main",
"snapshots":[{
"snapshotId":"2064.30c63e29-aacd-4b3b-803f-a09ce65486d2",
"name":"Hiring Sample 3",
"desc":"Hiring Sample for IBM BPM Standard",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316785559701
},
{
"snapshotId":"2064.088c3f8f-16d1-41e0-a058-68905dd5973a",
"name":"NotAuthorized",
"desc":"only tw_user",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316803074440
},
{
"snapshotId":"2064.6142d3a2-6ebf-4cd2-8e2d-2fcc6dc67efb",
"name":"mytest",
"desc":"Test with Participant group PS_AdminGroup users tw_admin and tw_user.",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316801484680
},
{
"snapshotId":"2064.af2ea748-b6e6-4c85-a9eb-49ed08c2cd7e",
"name":"snapshot2",
"desc":"",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316830087300
},
{
"snapshotId":"2064.d081cac7-6015-4a48-a0cd-f9a2dd800047",
"name":"v1.0",
"desc":"",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316788208125
},
{
"snapshotId":"2064.3a845571-9805-4802-ba93-11c6d521ea27",
"name":"v2.0",
"desc":"",
"createdBy_userId":1,
"createdBy_userName":"Internal TW Admin user",
"created_on":1316790646171
}
]
}
]
}
}
<?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:tProjectSnapshots"> <branches> <branchId>2063.1a52abd6-b068-4f9e-91a9-ded9793eb34e</branchId> <name>Main</name> <snapshots> <snapshotId>2064.30c63e29-aacd-4b3b-803f-a09ce65486d2</snapshotId> <name>Hiring Sample 3</name> <desc>Hiring Sample for IBM BPM Standard</desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317054105554</created_on> </snapshots> <snapshots> <snapshotId>2064.2d5cece0-9e62-4380-ac35-41c8c2544c25</snapshotId> <name>V2.0</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317078477755</created_on> </snapshots> <snapshots> <snapshotId>2064.db372b4d-226a-4c40-b250-9b6f941ca5b6</snapshotId> <name>V3.0</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317087248717</created_on> </snapshots> <snapshots> <snapshotId>2064.af2ea748-b6e6-4c85-a9eb-49ed08c2cd7e</snapshotId> <name>snapshot2</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317092466032</created_on> </snapshots> <snapshots> <snapshotId>2064.a0c67d45-292b-447d-9d2a-bed94cd254f1</snapshotId> <name>v1.0</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317061801088</created_on> </snapshots> <snapshots> <snapshotId>2064.fdf7b434-95ee-423c-994a-875dcae426b7</snapshotId> <name>v4.0</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317087725689</created_on> </snapshots> <snapshots> <snapshotId>2064.bc97a55f-f158-40f3-8d8f-b9915a0dcc0d</snapshotId> <name>v5.0</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317095001579</created_on> </snapshots> </branches> <branches> <branchId>2063.4f5ede00-5c09-4ced-be0a-7512e4322b63</branchId> <name>Track2</name> <snapshots> <snapshotId>2064.b77dfdb6-cb1b-441c-85b2-df8cfeea2b26</snapshotId> <name>Main - v1.0</name> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317078507521</created_on> </snapshots> <snapshots> <snapshotId>2064.9bc229af-b83c-446e-bcf5-dde8e6b49253</snapshotId> <name>track2_v2</name> <desc></desc> <createdBy_userId>1</createdBy_userId> <createdBy_userName>Internal TW Admin user</createdBy_userName> <created_on>1317078552411</created_on> </snapshots> </branches> </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: Project Named Snapshots List Resource