RErenesas
Document

Get Document by Agile ID

get/documents/agile-id/{agile_id}

Request

Path parameters

agile_idstring required

The Agile ID of the document.

Response

Successful response

agileIdstring

Primary Agile ID of the document.

dcpDocumentIdstring

DCP Document ID, if applicable.

urlstring uri

URL to download the document.

titlestring

Title of the document.

typestring

Type of the document (e.g., Flyer, App Note).

subTypestring[]

Sub-types of the document. 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.

fileTypestring

File format (e.g., PDF, DOCX).

secureDocumentboolean

Indicates if the document is secure or restricted.

revisionDatestring

Original revision date of the document.

wwwUpdateDatestring

Date the document was last updated on the website.

languagestring

Language of the document (e.g., en, ja, zh-hans).

nidstring

Drupal node ID of the document.

uuidstring

UUID of the document node.

publishedboolean

Publication status of the document.

featuredboolean

Whether the document is featured or highlighted.

relationshipstring

Relationship or association type, if any.

filenamestring

Original filename of the document.

myrenesasDocumentboolean

Is a MyRenesas document.

Example response

{
  "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.