Bug 1228802
| Summary: | Wrong endpoint in the REST API doc for /history/instances | ||
|---|---|---|---|
| Product: | [Retired] JBoss BPMS Platform 6 | Reporter: | William Antônio <wsiqueir> |
| Component: | Documentation | Assignee: | Vidya <viyengar> |
| Status: | CLOSED EOL | QA Contact: | Lukáš Petrovický <lpetrovi> |
| Severity: | low | Docs Contact: | Dawn Eisner <deisner> |
| Priority: | low | ||
| Version: | 6.1.0 | CC: | brms-docs, wsiqueir |
| Target Milestone: | CR2 | ||
| Target Release: | One-off release | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2020-03-27 20:06:04 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
William Antônio
2015-06-05 19:40:35 UTC
Hi William,
Should the endpoint for just the "/history/instance" be updated to "/history/instances"? Or should it be for all the listed parameters below it as well?
/history/instance/{id: [0-9]+}
/history/instance/{id: [0-9]+}/child
/history/instance/{id: [0-9]+}/node
----
---
---
---
This is a bit confusing as in section 16.1.3.2.4. History calls, this is what is documented:
/history/instances
returns logs of all Process instances [GET]
/history/instance/{procInstanceID}
returns all logs of Process instance (including child logs) [GET]
Hello,
Only the first example should be changes to instances, for example:
---
/task/query
/history/instances
/history/instance/{id: [0-9]+}
/history/instance/{id: [0-9]+}/child
/history/instance/{id: [0-9]+}/node
/history/instance/{id: [0-9]+}/node/{id: [a-zA-Z0-9-:\\.]+}
/history/instance/{id: [0-9]+}/variable/
/history/instance/{id: [0-9]+}/variable/{id: [a-zA-Z0-9-:\\.]+}
/history/process/{id: [a-zA-Z0-9-:\\.]+}
---
I could confirm that the endpoint /history/instances is working with pagination.
Thanks William. Fixed the topic. A link to the latest build of the updated document will be provided soon for your review. |