RQM REST API: How to obtain possible states of an executionresult?
Greetings,
Using RQM Reportable REST API (https://jazz.net/wiki/bin/view/Main/RqmApi),
I have a few questions about executionresult states obtained from a GET /executionresult/id
1) state is a name like 'com.ibm.rqm.execution.common.state.failed', how do I obtain the possible list of such names?
2) are these possible states customizable in RQM (using either UI or API)?
3) if they're customizable, how do I get Display Name of a state?
Accepted answer
1) com.ibm.rqm.execution.common.state.paused
com.ibm.rqm.execution.common.state.inprogress
com.ibm.rqm.execution.common.state.notrun
com.ibm.rqm.execution.common.state.passed
com.ibm.rqm.execution.common.state.perm_failed
com.ibm.rqm.execution.common.state.incomplete
com.ibm.rqm.execution.common.state.inconclusive
com.ibm.rqm.execution.common.state.part_blocked
com.ibm.rqm.execution.common.state.deferred
com.ibm.rqm.execution.common.state.failed
com.ibm.rqm.execution.common.state.error
com.ibm.rqm.execution.common.state.blocked
You can always set a state in the RQM UI and GET the execution result to determine the state.
Please open a RQM defect to update https://jazz.net/products/rational-quality-manager/api-doc-5.0/schemas/qm_xsd/elements/executionresult.html#a5.
2) Yes, see >> Execution States.
3) Unfortunately, the display name of the state is not exposed in the RQM Reportable REST API. Please open a RQM defect
com.ibm.rqm.execution.common.state.inprogress
com.ibm.rqm.execution.common.state.notrun
com.ibm.rqm.execution.common.state.passed
com.ibm.rqm.execution.common.state.perm_failed
com.ibm.rqm.execution.common.state.incomplete
com.ibm.rqm.execution.common.state.inconclusive
com.ibm.rqm.execution.common.state.part_blocked
com.ibm.rqm.execution.common.state.deferred
com.ibm.rqm.execution.common.state.failed
com.ibm.rqm.execution.common.state.error
com.ibm.rqm.execution.common.state.blocked
You can always set a state in the RQM UI and GET the execution result to determine the state.
Please open a RQM defect to update https://jazz.net/products/rational-quality-manager/api-doc-5.0/schemas/qm_xsd/elements/executionresult.html#a5.
2) Yes, see >> Execution States.
3) Unfortunately, the display name of the state is not exposed in the RQM Reportable REST API. Please open a RQM defect
Comments
Superb, thank you for such detailed answers!
I'm not sure what to open defect for the part of api-doc. I opened an enhancement for possibility to
1) obtaining display name
2) obtaining list of possible states (given that states are customizable and not fixed).
For 1), see The qm:executionresult/alm:state property does not document default execution states. (124431).