RErenesas
Document

Get All Documents

get/documents

Request

Query parameters

limitinteger

The number of results to return (default 10).

offsetinteger

The offset for pagination.

language'en' | 'ja' | 'zh-hans'

Filter by document language (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).

Response

Successful response

Example response

{
  "data": [
    {
      "agileId": "X0185126",
      "dcpDocumentId": "R01TB0099EJ0100",
      "url": "https://www.renesas.com/en/document/oth/ra8p1-group-handbook",
      "product": [
        {
          "productId": "RL78/G13",
          "title": "Sample Product Title",
          "nid": 12345,
          "uuid": "550e8400-e29b-41d4-a716-446655440000",
          "language": "en"
        }
      ],
      "title": "RA8P1 Group Handbook",
      "type": "Other",
      "subType": [
        "Driver Package"
      ],
      "fileType": "PDF",
      "disclaimer": [
        {
          "dcpDocumentId": "DISC789012",
          "language": "en",
          "agileId": "X1234567",
          "title": "Standard Product Disclaimer",
          "href": "/documents/DISC789012"
        },
        {
          "dcpDocumentId": "DISC789013",
          "language": "en",
          "agileId": "X1234567",
          "title": "Export Control Disclaimer",
          "href": "/documents/DISC789013"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.