Bug 1172479 - Incorrect REST API specified under section `13.3.2.2. Signal calls`
Summary: Incorrect REST API specified under section `13.3.2.2. Signal calls`
Keywords:
Status: CLOSED EOL
Alias: None
Deadline: 2015-05-07
Product: JBoss BPMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.0.3
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: CR2
: One-off release
Assignee: brms-docs@redhat.com
QA Contact: Ivo Bek
Dawn Eisner
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-12-10 07:23 UTC by Abhijit humbe
Modified: 2020-03-27 20:06 UTC (History)
1 user (show)

Fixed In Version:
Clone Of:
Environment:
Build Name: 22684, Development Guide-6.0-1 Build Date: 03-11-2014 02:10:16 Topic ID: 22217-627048 [Specified]
Last Closed: 2020-03-27 20:06:03 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Abhijit humbe 2014-12-10 07:23:58 UTC
Title: Signal calls
~~~
/runtime/{deploymentId}/signal/{signalCode}
~~~
Its an invalid REST API, if we try with this it fails with 404 exception.


Describe the issue:


Suggestions for improvement:

[POST] /runtime/{deploymentId}/signal

 This operation takes a signal and a event query parameter.

- The signal parameter value is used as the name of the signal. This parameter is required.
- The event parameter value is used as the value of the event. This value may use the number query parameter syntax described above. 


Example:

~~~~
/runtime/{deploymentId}/signal?signal={signalCode}
~~~~


Additional information:

Comment 2 Vikram Goyal 2014-12-12 06:02:27 UTC
Thanks Abhijit

I have made the change and this can be verified here [1]. Moving to ON_QA.

If you are happy with the change, I will push it live.

[1] https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/Development_Guide/index.html#sect-Runtime_calls

Comment 3 Ivo Bek 2015-03-31 08:33:03 UTC
Vikram, the changes are alright. Could you please also modify the following example where is the same problem?

Example 13.10. REST request body with the Integer mySignal parameter

/rest/runtime/business-central/process/org.jbpm.test/instance/2/signal?mySignal=1234i

Since the signal type needs to be String, I would recommend to use a different example like starting a process with integer parameter:

/rest/runtime/business-central/process/org.jbpm.test/start?map_var1=1234i

Comment 4 Vikram Goyal 2015-05-08 03:18:07 UTC
Sorry Ivo for the late reply. The example has been changed as suggested and can be verified here [1].

Moving back to ON_QA.

[1] https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/Development_Guide/index.html#sect-Runtime_calls

Comment 5 Ivo Bek 2015-05-25 11:58:23 UTC
Verified in BPMS 6.0 Development Guide and BPMS 6.1 Development Guide.


Note You need to log in before you can comment on or make changes to this bug.