Skip to content

Package

Endpoints for retrieving packages.

Operations

Get All Packages

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 100 ]

The number of results to return (default 10).

Default:10
offsetinteger, >= 0

The page number for pagination (default 0). This is multiplied by limit to get the actual offset.

Default:0
orderstring

Sorting property (default sort is by www update date). Multiple sorts can be supplied by comma concatenation.

Default:"wwwUpdateDate"
Enum:"wwwUpdateDate""packageCode""packageType""packageStatus"
Example:order=wwwUpdateDate,packageCode
orderDirectionstring

Sorting direction (default is "desc"). Multiple directions can be defined for multiple sorts.

Default:"desc"
Example:orderDirection=desc,asc
packageCodestring

Filter by package identifier.

packageTypestring

Filter by package type.

packageStatusstring

Filter by package status.

Enum:"Active""Inactive"
curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/packages?limit=10&offset=0&order=wwwUpdateDate%2CpackageCode&orderDirection=desc%2Casc&packageCode=string&packageType=string&packageStatus=Active' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
dataArray of objects(package)
paginationobject
Response
{
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 245,
    "has_more": true
  }
}