Skip to content

Get All Documents

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 100 ]

The number of results to return (default 10).

offsetinteger, >= 0

The offset for pagination.

languagestring

Filter by document language (en, ja, zh-hans).

Enum:"en""ja""zh-hans"
dcpDocumentIdStartsWithstring

Filter by DCP Document ID prefix.

productIdstring

Filter by associated product ID.

typestring

Filter by document type. Example values: Datasheet, Datasheet - Short-Form, Datasheet Addendum, Datasheet Change Notice Guide, Manual - Development Tools, Manual - Hardware, Manual - Software, Quick Start Guide, General Reliability Literature, ICP Test Report, Materials Composition Declaration, MSDS Document, Product Reliability Report.

subTypestring

Filter by document sub-type. Example values: Core Module, Driver Package, FIT Module, FreeRTOS, Software Integration System Application Example, Development Environment, Middleware, Migration Guide, Peripherals - Analog, Peripherals - Built-in Memory, Peripherals - Clock, Peripherals - Communication, Peripherals - Other, Peripherals - Security, Peripherals - Timer.

categorystring

Filter by the product category the document is associated with.

documentRevisionDateStartstring, (date)

Filter by documents revised on or after this date (YYYY-MM-DD).

documentRevisionDateEndstring, (date)

Filter by documents revised on or before this date (YYYY-MM-DD).

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/documents?limit=1&offset=0&language=en&dcpDocumentIdStartsWith=string&productId=string&type=string&subType=string&category=string&documentRevisionDateStart=2019-08-24&documentRevisionDateEnd=2019-08-24' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

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