Get Request Details

Details

URI /catalog/<catalog_id>/request/<request_id>
Use Catalog API to get the catalog ID and List Requests in the Catalog to get the request ID.
Method GET
Parameters

userIdentifier=<user_id>

    Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.

scope=[base|baseplusone|subtree]

  Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the object and its first level children are returned. If value is subtree, then the object and all of its descendants are returned.

detail=[required|basic|standard|template|full]

  Optional; default is full. See Values for the detail Parameter. Some API calls do not support all possible values for this parameter.

restrict=[true|false]

Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed.

See Values for the restrict Parameter for more information.

Returns 201 - Ok, object returned
401 - Not authorized
404 - Not found
500 - Server exception

Example

The following URL was sent:

https://localhost:8444/csa/rest/catalog/8a8181853810699a0138106dcebc0011/request/8a8181853810699a01381079190800a7/ ?userIdentifier=8a8181853810699a01381076be5400a0

The following XML was returned:


<ServiceRequest>
   <id>8a8181853810699a01381079190800a7</id>
   <objectId>8a8181853810699a01381079190800a7</objectId>
   <createdOn>2012-06-21T12:16:08.073-07:00</createdOn>
   <updatedOn>2012-06-21T12:16:50.787-07:00</updatedOn>
   <createdBy>
      <id>8a8181853810699a01381076be5400a0</id>
      <objectId>8a8181853810699a01381076be5400a0</objectId>
      <isCriticalSystemObject>false</isCriticalSystemObject>
      <name>consumer1</name>
      <disabled>false</disabled>
   </createdBy>
   <updatedBy>
      <id>90d96588360da0c701360da0f1d5f483</id>
      <objectId>90d96588360da0c701360da0f1d5f483</objectId>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <name>admin</name>
      <displayName>admin</displayName>
      <disabled>false</disabled>
   </updatedBy>
   <isCriticalSystemObject>false</isCriticalSystemObject>
   <description>SD2 Offering</description>
   <detailedDescription>desc - SD2 offering</detailedDescription>
   <iconUrl>/csa/images/library/application.png</iconUrl>
   <name>request 1</name>
   <displayName>request 1</displayName>
   <catalogItem>
      <id>8a8181853810699a01381079202c00d7</id>
      <createdOn>2012-06-21T12:16:09.900-07:00</createdOn>
      <updatedOn>2012-06-21T12:16:09.900-07:00</updatedOn>
      <createdBy>
         <id>8a8181853810699a01381076be5400a0</id>
         <objectId>8a8181853810699a01381076be5400a0</objectId>
         <isCriticalSystemObject>false</isCriticalSystemObject>
         <name>consumer1</name>
         <disabled>false</disabled>
      </createdBy>
      ...
      <priceCategory>
         <id>90d9650a36897af90136897bc93e0016</id>
         <objectId>90d9650a36897af90136897bc93e0016</objectId>
         <createdOn>2012-06-21T11:51:43.633-07:00</createdOn>
         <isCriticalSystemObject>true</isCriticalSystemObject>
         <description>SETUP</description>
         <iconUrl>/csa/images/categories/price/setup.png</iconUrl>
         <name>SETUP</name>
         <displayName>SETUP</displayName>
         <disabled>false</disabled>
         <categoryType>
            <id>90d9650a36897af90136897bc7c70014</id>
            <objectId>90d9650a36897af90136897bc7c70014</objectId>
            <isCriticalSystemObject>false</isCriticalSystemObject>
            <name>PRICE_CATEGORY</name>
            <displayName>Price Category</displayName>
            <extensible>false</extensible>
         </categoryType>
      </priceCategory>
      <fixedPrice>3000.0</fixedPrice>
      <unitPrice>0.0</unitPrice>
   </basePrice>
</ServiceRequest>