Serena Requirements Manager 1.0 Web Services Reference

Table of Contents

Overview

Description

This document contains Web Service descriptions for the following services.

Web Services
Name  Description 
getRMDocuments  Returns a list of all available documents in the specified Dimensions RM project. Output can be limited by a filter.
getRMCollections  Returns a list of all available collections in the specified Dimensions RM project. Output can be limited by a filter.
getRMSnapshots  Returns a list of all available snapshots in a specific Dimensions RM project. Output can be limited by a filter.

getRMDocuments Web Service

Description

Returns a list of all available documents in the specified Dimensions RM project. Output can be limited by a filter.

Type

REST

See Also

Methods

Methods: getRMDocuments

Methods
Name 
getRMDocuments 

Method: getRMDocuments

Action

http://{sbmServer:string}:{sbmPort:string}/ReqManager/services/rest/getRMDocuments?designMode={boolean}&dbName={string}&filter={string}&project={string}&username={string}&password={string}&server={string}&port={string}

Style

HTTP GET

Input

The inputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
sbmServer  string  1..1  SBM server hosting the web service.
sbmPort  string  1..1  Port of the SBM server.
designMode  boolean  1..1  Service returns sample data if enabled without connection. [true | false]
dbName  string  1..1  Dimensions RM database name.
filter  string  1..1  Service returns data according to filter if specified.
project  string  1..1  Dimensions RM project name.
username  string  1..1  Username for Dimensions RM login.
password  string  1..1  User password for Dimensions RM login.
server  string  1..1  Dimensions RM server name.
port  string  1..1  Dimensions RM server port.
Output (XML)

The outputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
RMDocuments    1..1  Includes the ID, Name, and URL for each document.
Remarks

Below is an output example.

Example

<RMDocuments>
  <RMDocument>
    <nId>31</nId>
    <sName>ePhoto Marketing Reqs</sName>
    <sURL>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=doc&db=OALM&proj=RMDEMO&doc=ePhoto%20Marketing%20Reqs
    </sURL>
  </RMDocument>
  <RMDocument>
    <nId>12</nId>
    <sName>ePhoto Requirements</sName>
    <sURL>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=doc&db=OALM&proj=RMDEMO&doc=ePhoto%20Requirements
    </sURL>
  </RMDocument>
</RMDocuments>

getRMCollections Web Service

Description

Returns a list of all available collections in the specified Dimensions RM project. Output can be limited by a filter.

Type

REST

See Also

Methods

Methods: getRMCollections

Methods
Name 
getRMCollections 

Method: getRMCollections

Action

http://{sbmServer:string}:{sbmPort:string}/ReqManager/services/rest/getRMCollections?designMode={boolean}&dbName={string}&filter={string}&project={string}&username={string}&password={string}&server={string}&port={string}

Style

HTTP GET

Input

The inputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
sbmServer  string  1..1  SBM server hosting the web service.
sbmPort  string  1..1  Port of the SBM server.
designMode  boolean  1..1  Service returns sample data if enabled without connection. [true | false]
dbName  string  1..1  Dimensions RM database name.
filter  string  1..1  Service returns data according to filter if specified.
project  string  1..1  Dimensions RM project name.
username  string  1..1  Username for Dimensions RM login.
password  string  1..1  User password for Dimensions RM login.
server  string  1..1  Dimensions RM server name.
port  string  1..1  Dimensions RM server port.
Output (XML)

The outputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
RMCollections    1..1  Includes the ID, Name, Type, and URL for each collection.
Remarks

Below is an output example.

Example

<RMCollections>
  <RMCollection>
    <id>11</id>
    <name>Baseline of Engineering Hot List</name>
    <type>C</type>
    <url>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=collection&db=OALM&proj=RMDEMO&collection=Baseline%20of%20Engineering%20Hot%20List
    </url>
  </RMCollection>
  <RMCollection>
    <id>5</id>
    <name>Engineering Hot List</name>
    <type>C</type>
    <url>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=collection&db=OALM&proj=RMDEMO&collection=Engineering%20Hot%20List
    </url>
  </RMCollection></RMCollections>

getRMSnapshots Web Service

Description

Returns a list of all available snapshots in a specific Dimensions RM project. Output can be limited by a filter.

Type

REST

See Also

Methods

Methods: getRMSnapshots

Methods
Name 
getRMSnapshots 

Method: getRMSnapshots

Action

http://{sbmServer:string}:{sbmPort:string}/ReqManager/services/rest/getRMSnapshots?designMode={boolean}&dbName={string}&project={string}&filter={string}&username={string}&password={string}&documentId={string}&server={string}&port={string}

Style

HTTP GET

Input

The inputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
sbmServer  string  1..1  SBM server hosting the web service.
sbmPort  string  1..1  Port of the SBM server.
designMode  boolean  1..1  Service returns sample data if enabled without connection. [true | false]
dbName  string  1..1  Dimensions RM database name.
project  string  1..1  Dimensions RM project name.
filter  string  1..1  Service returns data according to filter if specified.
username  string  1..1  Username for Dimensions RM login.
password  string  1..1  User password for Dimensions RM login.
documentId  string  1..1  The ID of the document for which the service will return snapshots.
server  string  1..1  Dimensions RM server name.
port  string  1..1  Dimensions RM server port.
Output (XML)

The outputs of this method are the arguments defined by the following table.

Argument  Type  Occurs  Description 
    1..1   
RMSnapshots    1..1  Includes the Document ID, ID, Name, and URL for each snapshot.
Remarks

Below is an output example.

Example

<RMSnapshots>
  <RMSnapshot>
    <documentId>12</documentId>
    <id>15</id>
    <name>ePhoto Requirements 1.0</name>
    <url>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=doc&db=OALM&proj=RMDEMO&doc=ePhoto%20Requirements%201.0
    </url>
  </RMSnapshot>
  <RMSnapshot>
    <documentId>12</documentId>
    <id>17</id>
    <name>ePhoto Requirements 2.0</name>
    <url>
      http://RQMserver/rtmBrowser/cgi-bin/rtmBrowser.exe?goto=doc&db=OALM&proj=RMDEMO&doc=ePhoto%20Requirements%202.0
    </url>
  </RMSnapshot></RMSnapshots>