IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/timinginterval/{timingIntervalId}[?snapshotId={string}][&branchId={string}]
| Name | Value Type | Description |
|---|---|---|
| snapshotId | string | The ID of the snapshot associated with the timing interval. Either 'snapshotId' or 'branchId' must be specified.
|
| branchId | string | The ID of the branch associated with the timing interval. Either 'snapshotId' or 'branchId' must be specified.
|
None
The default content type is application/json.
{
"status":"200",
"data":{
"timingIntervalId":{"type": "string", "description": "The ID of the timing interval."},
"name":{"type": "string", "description": "The name of the timing interval."},
"desc":{"type": "string", "description": "The description of the timing interval."},
"externalUniqueId":{"type": "string", "description": "The external unique ID of the timing interval."},
"intervalStart":{"type": "string", "description": "The point of calculation.",
"enum":
[
"earliest",
"latest"
]
},
"intervalEnd":{"type": "string", "description": "The point of calculation.",
"enum":
[
"earliest",
"latest"
]
},
"timeIntervalBounds":
[
{
"boundId":{"type": "string", "description": "The ID of the timing interval bound."},
"type":{"type": "string", "description": "The type of the timing interval bound.",
"enum":
[
"start",
"end"
]
},
"bpdRef":{
"bpdName":{"type": "string", "description": "The name of the business process definition referred by the timing interval bound."},
"bpdId":{"type": "string", "description": "The ID of the business process definition referred by the timing interval bound."},
"snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the business process definition.
Either 'snapshotId' or 'branchId' must be specified."},
"branchId":{"type": "string", "description": "The ID of the branch associated with the business process definition.
Either 'snapshotId' or 'branchId' must be specified."}
},
"serviceRef":{
"serviceName":{"type": "string", "description": "The name of the service referred by the timing interval bound."},
"serviceId":{"type": "string", "description": "The ID of the service referred by the timing interval bound."},
"snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the service.
Either 'snapshotId' or 'branchId' must be specified."},
"branchId":{"type": "string", "description": "The ID of the branch associated with the service.
Either 'snapshotId' or 'branchId' must be specified."}
},
"trackingGroupRef":{
"trackingGroupName":{"type": "string", "description": "The name of the tracking group referred by the timing interval bound."},
"trackingGroupId":{"type": "string", "description": "The ID of the tracking group referred by the timing interval bound."},
"snapshotId":{"type": "string", "description": "The ID of the snapshot associated with the tracking group.
Either 'snapshotId' or 'branchId' must be specified."},
"branchId":{"type": "string", "description": "The ID of the branch associated with the tracking group.
Either 'snapshotId' or 'branchId' must be specified."}
},
"trackingPointName":{"type": "string", "description": "The name of the tracking point."},
"TrackingPointEuid":{"type": "string", "description": "The effective UID of the tracking point."}
}
]
}
}
{
"status":"200",
"data":{
"timingIntervalId":"15.3d373266-5942-4605-a1f3-0fd51631dd1e",
"name":"TimingInterval1",
"desc":"description of timing interval 1",
"externalUniqueId":"X168226e8c8231",
"intervalStart":"earliest",
"intervalEnd":"latest",
"timeIntervalBounds":[{
"boundId":"2020.753a054f-c1b2-4f22-99fe-2cd0c8bc91d8",
"type":"start",
"bpdRef":{
"bpdName":"HR Open New Position",
"bpdId":"25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"serviceRef":null,
"trackingGroupRef":{
"trackingGroupName":"TG1",
"trackingGroupId":"14.298c3209-1637-4f1f-a729-ec7529729592",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingPointName":"TP1",
"TrackingPointEuid":"F6bfbac8c8231"
},
{
"boundId":"2020.e557d0d0-2423-499a-91ca-19abe0c11ea6",
"type":"end",
"bpdRef":{
"bpdName":"HR Open New Position",
"bpdId":"25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"serviceRef":null,
"trackingGroupRef":{
"trackingGroupName":"TG2",
"trackingGroupId":"14.7425a6f9-9216-487f-ab53-46834e59d3af",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingPointName":"TP2",
"TrackingPointEuid":"de7bfd8c8231"
},
{
"boundId":"2020.bd9ffca8-5c68-437a-9554-0be07e04f795",
"type":"start",
"bpdRef":null,
"serviceRef":{
"serviceName":"Submit Requisition",
"serviceId":"1.551dd543-a770-4d6c-b0e0-1c9d61242e55",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingGroupRef":{
"trackingGroupName":"TG1",
"trackingGroupId":"14.298c3209-1637-4f1f-a729-ec7529729592",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingPointName":"TP3",
"TrackingPointEuid":"m395d305ac8231"
},
{
"boundId":"2020.c8895625-73ba-41ac-a73e-d434ce4bb81f",
"type":"end",
"bpdRef":null,
"serviceRef":{
"serviceName":"Submit Requisition",
"serviceId":"1.551dd543-a770-4d6c-b0e0-1c9d61242e55",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingGroupRef":{
"trackingGroupName":"TG2",
"trackingGroupId":"14.7425a6f9-9216-487f-ab53-46834e59d3af",
"snapshotId":"2064.1046d0ec-d722-4703-89cd-8417a096a56a",
"branchId":null
},
"trackingPointName":"TP4",
"TrackingPointEuid":"O3ab8355ac8231"
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/timinginterval" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/timinginterval" 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" /> <simpleType name="BoundType"> <restriction base="string"> <enumeration value="start" /> <enumeration value="end" /> </restriction> </simpleType> <complexType name="BPDRefInfo"> <sequence> <element name="bpdName" type="string" /> <element name="bpdId" type="string" /> <choice> <element name="snapshotId" type="string" /> <element name="branchId" type="string"/> </choice> </sequence> </complexType> <complexType name="ServiceRefInfo"> <sequence> <element name="serviceName" type="string" /> <element name="serviceId" type="string" /> <choice> <element name="snapshotId" type="string" /> <element name="branchId" type="string"/> </choice> </sequence> </complexType> <complexType name="TrackingGroupRefInfo"> <sequence> <element name="trackingGroupName" type="string" /> <element name="trackingGroupId" type="string" /> <choice> <element name="snapshotId" type="string" /> <element name="branchId" type="string"/> </choice> </sequence> </complexType> <complexType name="TimingIntervalBoundType"> <sequence> <element name="boundId" type="string" /> <element name="TrackingPointEuid" type="string" /> <element name="type" type="tns:BoundType"/> <choice> <element name="bpdRef" type="tns:BPDRefInfo" /> <element name="serviceRef" type="tns:ServiceRefInfo"/> </choice> <element name="trackingGroupRef" type="tns:TrackingGroupRefInfo"/> <element name="trackingPointName" type="string"/> </sequence> </complexType> <complexType name="TimingIntervalType"> <complexContent> <extension base="pref:Data"> <sequence> <element name="timingIntervalId" type="string" /> <element name="name" type="string" /> <element name="desc" type="string" /> <element name="richDesc" type="string" /> <element name="externalUniqueId" type="string" /> <element name="intervalStart" type="string" /> <element name="intervalEnd" type="string" /> <element name="timeIntervalBounds" type="tns:TimingIntervalBoundType" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType> </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 | Successful completion - detailed report returned.
|
| 400 Bad Request | The parameters are not valid or they are missing. |
| 404 Not Found | The resource does not exist. |
| 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: Timing Interval Resource