IBM Support

Exporting the ReqIF File containing the requirements using REST API

How To


Summary

How to Export the ReqIF File containing the requirements using REST API

Steps

1)Create a ReqIF Definition in the DOORS NG.
2)Type the below URL in the browser and get the list of ReqIF Definitions created in DNG.
https://<server>:9443/rm/reqif/definitions?resourceContext=https://<server>:9443/rm/rm-projects/<project_id>/components/<component_id>
3)A .rdf File will be generated.

For Ex:

https://jazz.ibm.com:9443/rm/reqif/definitions?resourceContext=https://jazz.ibm.com:9443/rm/rm-projects/_JNvBkMXyEemz4N5aE1p9EA /components/_JNvBkMXyEemz4N5aE1p9EA

P1

ReqIF Definition : https://jazz.ibm.com:9443/rm/reqif/_Hvg74YYoEeqy86prOUqMsA

  • Method 1:

POST Method URL:

https://jazz.ibm.com:9443/rm/reqif_oslc/export?componentURI=https://<server>:9443/rm/rm-projects/<project_id>/components/<component id>

For Ex:

https://jazz.ibm.com:9443/rm/reqif_oslc/export?componentURI=https://jazz.ibm.com:9443/rm/rm-projects/_JNvBkMXyEemz4N5aE1p9EA/components/_JNvBkMXyEemz4N5aE1p9EA

Headers:

OSLC-Core-Version : 2.0

Content-Type: application/rdf+xml

oslc_config.context:https://<server>:9443/gc/configuration/26(GlobalConfiguration)

vvc.configuration: https://<server>:9443/rm/cm/stream/<stream_Id>(Local Configuration)

net.jazz.jfs.owning-context:https://<server>:9443/rm/rm-projects/<project_id>/components/<component_id>

For Ex:

OSLC-Core-Version : 2.0

Content-Type: application/rdf+xml

oslc_config.context:https://jazz.ibm.com:9443/gc/configuration/26

vvc.configuration:https://jazz.ibm.com:9443/rm/cm/stream/_1Thftk4WEeqP383r8d4uHw

net.jazz.jfs.owning-context:https://jazz.ibm.com:9443/rm/rm-projects/_JNvBkMXyEemz4N5aE1p9EA/components/_JYxM4MXyEemz4N5aE1p9EA

P2

Body:

<rdf:RDF

xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"

xmlns:dng_reqif="http://jazz.net/ns/rm/dng/reqif#">

<dng_reqif:ReqIFExport>

<dng_reqif:definition rdf:resource="https://jazz.ibm.com:9443/rm/reqif/_Hvg74YYoEeqy86prOUqMsA"/>;

</dng_reqif:ReqIFExport>

</rdf:RDF>

P3
  • Method 2:

POST Method URL:

https://<server>:9443/rm/reqif/export?reqIFDataDefinition=https://<server>:9443/rm/reqif/<reqIF_id>

For Example:

https://jazz.ibm.com:9443/rm/reqif/export?reqIFDataDefinition=https://jazz.ibm.com:9443/rm/reqif/_Hvg74YYoEeqy86prOUqMsA

P4

Headers:

OSLC-Core-Version : 2.0

Content-Type: application/rdf+xml

oslc_config.context:https://<server>:9443/gc/configuration/26(GlobalConfiguration)

vvc.configuration: https://<server>:9443/rm/cm/stream/<stream_Id>(Local Configuration)

net.jazz.jfs.owning-context:https://<server>:9443/rm/rm-projects/<project_id>/components/<component_id>

P5

  • 3)Successful ReqIF export through Rest API can be observed in Manage component properties—>ReqIF Page:
P6

Document Location

Worldwide

[{"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSUVLZ","label":"IBM Engineering Requirements Management DOORS Next"},"ARM Category":[{"code":"a8m50000000Cj0bAAC","label":"DOORS Next Generation-\u003EAPIs-\u003EREST API"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Product Synonym

Rational DOORS Next Generation

Document Information

Modified date:
06 August 2024

UID

ibm16247509

Page Feedback