Getting Details of a Request

Request: http://<PPM_Server_IP>:<port>/itg/rest/dm/requests/{reqId}

HTTP Method: GET

Description: Get a request specified by the request ID.

Request path variables:

Attribute	Description	Required
reqId	The ID of the request	Yes

Response entity body:

on success: Returns an XML object of the request with the following format:

<ns2:request xmlns:ns2="http://www.hp.com/ppm/dm/">
   <id>30362</id>
   <description>This is a test request</description>
   <requestType>test</requestType>
   <sourceType />
   <source />
   <fields>
     <field>
        <token>REQD.LINK</token>
        <stringValue>17.11.http://www.hp.com.HP web site</stringValue>
     </field>
     <field>
        <token>REQ.REQUEST_GROUP_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.STATUS_NAME</token>
        <stringValue>New</stringValue>
     </field>
     <field>
        <token>REQ.PERCENT_COMPLETE</token>
        <stringValue>0</stringValue>
     </field>
     <field>
        <token>REQ.PRIORITY_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQD.RESOL_SUM</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.DEPARTMENT_NAME</token>
        <stringValue>Finance</stringValue>
     </field>
     <field>
        <token>REQ.WORKFLOW_NAME</token>
        <stringValue>Bug Request Type Workflow</stringValue>
     </field>
     <field>
        <token>REQ.CONTACT_EMAIL</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.REQUEST_ID</token>
        <stringValue>30362</stringValue>
     </field>
     <field>
        <token>REQ.DESCRIPTION</token>
        <stringValue>This is a test request</stringValue>
     </field>
     <field>
        <token>REQ.ASSIGNED_TO_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.CREATED_BY</token>
        <stringValue>Admin User</stringValue>
     </field>
     <field>
        <token>REQ.STATUS_CODE</token>
        <stringValue>IN_PROGRESS</stringValue>
     </field>
     <field>
        <token>REQ.LAST_UPDATE_DATE</token>
        <dateValue>2012-08-29T15:41:55.000+08:00</dateValue>
     </field>
     <field>
        <token>REQD.MODULE</token>
        <stringValue>Module B</stringValue>
     </field>
     <field>
        <token>REQ.ASSIGNED_TO_GROUP_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.REQUEST_TYPE_NAME</token>
        <stringValue>test</stringValue>
     </field>
     <field>
        <token>REQ.REQUEST_SUB_TYPE_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.CONTACT_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.CONTACT_PHONE_NUMBER</token>
        <stringValue />
     </field>
     <field>
        <token>REQ.ENTITY_LAST_UPDATE_DATE</token>
        <dateValue>2012-08-29T15:41:55.000+08:00</dateValue>
     </field>
     <field>
        <token>REQ.CREATION_DATE</token>
        <dateValue>2012-08-29T15:41:54.000+08:00</dateValue>
     </field>
     <field>
        <token>REQ.APPLICATION_NAME</token>
        <stringValue />
     </field>
     <field>
        <token>REQD.TABLE_TEST</token>
        <tableValue>
          <columnTokens>
            <columnToken>T.TABLE_TEST.ID</columnToken>
            <columnToken>T.TABLE_TEST.NAME</columnToken>
            <columnToken>T.TABLE_TEST.GENDER<columnToken>
          </columnTokens>
          <row>
            <columns>
              <column>
                <stringValue>1000</stringValue>
              </column>
              <column>
                <stringValue>Alexander</stringValue>
              </column>
              <column>
                <stringValue>male/man</stringValue>
              </column>
              </columns>
            </row>
            <row>
             <columns>
               <column>
                 <stringValue>1001</stringValue>
               </column>
               <column>
                 <stringValue>Beetle</stringValue>
               </column>
               <column>
                 <stringValue>male/man</stringValue>
               </column>
              </columns>
            </row>
        </tableValue>
     </field>
   </fields>
   <notes />
   <references />
</ns2:request>

on failure: The following message codes are returned if the operation fails:

Message Code	Message	Cause	Possible Corrective Action
PPM_WSE000	Internal Error	There was an internal error when you executed the operation.	N/A
PPM_WSE001	Cannot Get Internal Server Connection	There was an error when you tried to connect to the PPM server.	N/A
PPM_WSE101	Error when trying to read request with id {0}	There was some error when the system tried to read the request.	N/A
PPM_WSE108	The request {0} does not exist	The request ID you entered does not exist.	Correct the request ID in the URL
PPM_SWE209	No eligible actions for this request	The request you tried to access does not have any eligible actions for the you.	Add the user to the workflow step security.

Limitation:

This operation returns the visual field values instead of the parameter values. It does not return all the types fields, such as financial summary, staffing profile, attachment, and etc.

Getting Details of a Request

Send Help Center Feedback