Getting a Request Type

Request: http://<PPM_Server_IP>:<port>/itg/rest/dm/requestTypes/{id}

HTTP Method: GET

Description: Get a request type specified by request type ID.

Request path variables:

Attribute Description Required
id The ID of the request type Yes

Response entity body:

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

    <ns2:requestType xmlns:ns2="http://www.hp.com/ppm/dm/">
       <id>31430</id>
       <name>test</name>
       <description>Bug Request type</description>
       <referenceCode>TEST</referenceCode>
       <fields>
          <field>
            <token>REQ.REQUEST_ID</token>
            <prompt>Request No.:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1027</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>true</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.REQUEST_TYPE_NAME</token>
            <prompt>Request Type:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2001</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.CREATED_BY</token>
            <prompt>Created By:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1065</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>true</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>true</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.DEPARTMENT_NAME</token>
            <prompt>Department:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1156</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.REQUEST_SUB_TYPE_NAME</token>
            <prompt>Sub-Type:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1068</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.CREATION_DATE</token>
            <prompt>Created On:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1028</validationId>
            <dataType>Date</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>true</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>true</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.WORKFLOW_NAME</token>
            <prompt>Workflow:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2003</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.STATUS_NAME</token>
            <prompt>Request Status:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1036</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>true</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.PRIORITY_NAME</token>
            <prompt>Priority:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1063</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.APPLICATION_NAME</token>
            <prompt>Application:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1064</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.CONTACT_NAME</token>
            <prompt>Contact Name:</prompt>
            <description />
            <section>Summary</section>
            <validationId>130</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.ASSIGNED_TO_NAME</token>
            <prompt>Assigned To:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2004</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.ASSIGNED_TO_GROUP_NAME</token>
            <prompt>Assigned Group:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2005</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.CONTACT_PHONE_NUMBER</token>
            <prompt>Contact Phone:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2024</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.REQUEST_GROUP_NAME</token>
            <prompt>Request Group:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1440</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.CONTACT_EMAIL</token>
            <prompt>Contact Email:</prompt>
            <description />
            <section>Summary</section>
            <validationId>2022</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>true</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.DESCRIPTION</token>
            <prompt>Description:</prompt>
            <description />
            <section>Summary</section>
            <validationId>1069</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQ.PERCENT_COMPLETE</token>
            <prompt>% Complete:</prompt>
            <description>Percent Complete Field</description>
            <section>Summary</section>
            <validationId>1027</validationId>
            <dataType>Text</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>false</display>
            <displayOnly>true</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
          </field>
          <field>
            <token>REQD.TABLE_TEST</token>
            <prompt>tablecomponent</prompt>
            <description />
            <section>Bug</section>
            <validationId>32863</validationId>
            <dataType>Table</dataType>
            <maxLength>200</maxLength>
            <defaultValue />
            <required>false</required>
            <multi>false</multi>
            <display>true</display>
            <displayOnly>false</displayOnly>
            <readOnly>false</readOnly>
            <createOnly>false</createOnly>
            <updateOnly>false</updateOnly>
            <migrateOK>false</migrateOK>
            <viewRestricted>false</viewRestricted>
            <editRestricted>false</editRestricted>
            <table>
              <column>
                <token>T.TABLE_TEST.ID</token>
                <prompt>ID</prompt>
                <description />
                <validationId>1027</validationId>
                <dataType>Text</dataType>
                <maxLength>40</maxLength>
                <defaultValue />
                <required>false</required>
                <multi>false</multi>
                <display>true</display>
                <displayOnly>false</displayOnly>
                <readOnly>false</readOnly>
                <createOnly>false</createOnly>
                <updateOnly>false</updateOnly>
                <migrateOK>false</migrateOK>
                <viewRestricted>false</viewRestricted>
                <editRestricted>false</editRestricted>
              </column>
              <column>
                <token>T.TABLE_TEST.NAME</token>
                <prompt>Name</prompt>
                <description />
                <validationId>1027</validationId>
                <dataType>Text</dataType>
                <maxLength>40</maxLength>
                <defaultValue />
                <required>false</required>
                <multi>false</multi>
                <display>true</display>
                <displayOnly>false</displayOnly>
                <readOnly>false</readOnly>
                <createOnly>false</createOnly>
                <updateOnly>false</updateOnly>
                <migrateOK>false</migrateOK>
                <viewRestricted>false</viewRestricted>
                <editRestricted>false</editRestricted>
             </column>
             <column>
                <token>T.TABLE_TEST.GENDER</token>
                <prompt>gender</prompt>
                <description />
                <validationId>32864</validationId>
                <dataType>Text</dataType>
                <maxLength>200</maxLength>
                <defaultValue />
                <required>false</required>
                <multi>false</multi>
                <display>true</display>
                <displayOnly>false</displayOnly>
                <readOnly>false</readOnly>
                <createOnly>false</createOnly>
                <updateOnly>false</updateOnly>
                <migrateOK>false</migrateOK>
                <viewRestricted>false</viewRestricted>
                <editRestricted>false</editRestricted>
              </column>
            </table>
          </field>
       </fields>
    </ns2:requestType> 
  • 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_WSE020

    The Request Type {0} doesn't exist

    The request type that the user tried to access does not exist.

    Correct the Request Type ID in the URL.

    PPM_WSE021

    You do not have access to view Request Types

    The user executing this operation does not have the required access grants.

    Verify that the user has the required access grants. For more information, see Function.

    PPM_WSE023

    The request type with ID {0} is not enabled

    The request type that the user tried to access is not enabled.

    Enable the request type.