Jump to

• Request
• Response
• Examples

Get list of products

get

/PASService/rest/services/products

Gets a list of latest 100 products. Also, define expand attributes to expand a product by its sub-resources such as plans

Request

Query Parameters

• expand(optional): string
  plans, codes
• q(optional): string
  Search Parameter

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top

Examples

This example describes how to get a list of latest 100 products and aslo how to define expand attributes to expand a product by its sub-resources such as plans.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/products"

Example Response Body

The following shows an example of the response body in JSON format:

"{
    "count": 40,
    "offset": 0,
    "limit": 100,
    "products": [
        {
            "links": [
                {
                    "href": "http://server:port/PASService/rest/services/products/62D404B3-0E7F-44F9-9C94-27AACF7FDA72",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/products/62D404B3-0E7F-44F9-9C94-27AACF7FDA72/plans",
                    "rel": "plans",
                    "mediaType": "application/json",
                    "method": "GET"
                }
            ],
            "productName": "SProd",
            "productDescription": "SProd",
            "effectiveFrom": "2019-11-19T00:00:00Z",
            "effectiveTo": "2020-11-19T00:00:00Z",
            "ancestorId": "42D404B3-0E7F-44F9-9C94-27AACF7FDA72",
            "plans": {},
            "productId": "62D404B3-0E7F-44F9-9C94-27AACF7FDA72",
            "companyId": "05711222-7DB3-4EBD-A821-57A30A699B88"
        }
"

Back to Top