how to define an External ID for test artifacts?
Hi,
I read in the RQM API that when uploading new artifacts to RQM, we can define External ID as an unique identifier: "This is an ID that is provided by the user when creating a resource with a PUT. Resources created from the Web UI will not have external IDs. An external ID can be anything that is valid in a URL".
So my question is, what format should the External ID be in the test artifact XML file? Can some one provide an example?
Also, if I want to add an External ID to an existing test artifact that was created in web GUI initially, what should I do? download the XML, add an external ID and then upload it back? Any other ways?
Thank you!!
I read in the RQM API that when uploading new artifacts to RQM, we can define External ID as an unique identifier: "This is an ID that is provided by the user when creating a resource with a PUT. Resources created from the Web UI will not have external IDs. An external ID can be anything that is valid in a URL".
So my question is, what format should the External ID be in the test artifact XML file? Can some one provide an example?
Also, if I want to add an External ID to an existing test artifact that was created in web GUI initially, what should I do? download the XML, add an external ID and then upload it back? Any other ways?
Thank you!!
One answer
The external id is specified in the URL when you do a PUT to create the artifact. For example,
https://localhost:9443/jazz/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Quality+Manager/testcase/mySpecialTestCase1
In which case "mySpecialTestCase1" will the the external id of the test case.
There is no way to modify an artifacts external ID. So you cannot add an external ID to a resources that was created in the UI. I believe the intention with the external ID was to provide an easy way for external programs to create and reference the artifacts they created via the REST API. Not as a means for external programs to work with artifacts that were created in the RQM UI.
https://localhost:9443/jazz/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Quality+Manager/testcase/mySpecialTestCase1
In which case "mySpecialTestCase1" will the the external id of the test case.
There is no way to modify an artifacts external ID. So you cannot add an external ID to a resources that was created in the UI. I believe the intention with the external ID was to provide an easy way for external programs to create and reference the artifacts they created via the REST API. Not as a means for external programs to work with artifacts that were created in the RQM UI.