Getting Time Periods

Request: http://<PPM_Server_IP>:<port>/itg/rest/tm/timePeriods

HTTP Method: GET

Description: Get time periods

Request path variables:

Attribute Description
type The type of the time period
date The date you want to check. The format of the date should be yyyy-MM-ddTHH:mm:ssZ

Response entity body:

  • on success: Return an XML object of the time periods with the following format:

    <ns2:periods xmlns:ns2="http://www.hp.com/ppm/tm/">
   <period>
     <id>102321</id>
     <preId>102320</preId>
     <nexId>102322</nexId>
     <sequence>131</sequence>
     <type>2</type>
     <startDate>2012-12-24T00:00:00.000-08:00</startDate>
     <endDate>2013-01-06T23:59:59.000-08:00</endDate>
   </period>
</ns2:periods>

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

    Message Code

    HTTP Return Code

    Message

    Cause

    Possible Corrective Action

    PPM_WSE000

    500

    Internal Error

    There was an internal error when you executed the operation.

    N/A

    PPM_WSE001

    503

    Cannot Get Internal Server Connection.

    There was an error when you tried to connect to the PPM server.

    N/A

    PPM_WSE506

    400

    The input date or type is invalid, for the data supports the format yyyy-MM-ddTHH:mm:ssZ, and the type is defined as 1, 2, 3, or 4.

    The input date or type is invalid

    Input correct query parameters.