From what I have gathered, an API definition in RAML (RESTful API Modeling Language) format is a way to describe the structure and behavior of a RESTful API.
It provides a clear and standardized way to document how different parts of the API work, including the resources, methods, parameters, and responses. Here's a simple breakdown:
An example:
Title: The name of the API.
Version: The version of the API.
Base URI: The root URL for the API.
Media Type: The default data format (e.g., JSON, XML).
Resources: The endpoints or URLs that the API exposes.
Methods: The HTTP methods (GET, POST, PUT, DELETE, etc.) supported by each resource.
Parameters: The inputs required or optional for each method.
Responses: The outputs or results returned by the API for each method.
#%RAML 1.0
title: Hello <some _text>
version: v1
description: Hello World API
baseUri: https://URL_of_some_sort/hello
mediaType: application/json
/health:
get:
/hello:
get:
description: |
My first API - Hello
queryParameters:
name:
required: false
type: string
example: John
responses:
200:
description: OK, request has succeeded
body:
application/json:
example: |
{ "message": "Hello" }
Let me know if this helps some.
------------------------------
C Powers
------------------------------
Original Message:
Sent: Mon December 08, 2025 11:50 AM
From: Oktawian Powązka
Subject: ILMT REST API in RAML or JSON format
To be honest I have no idea what kind of info would you like to get for those two.
There are no such things as schema description & columns for those two...
------------------------------
Thank you,
Oktawian
Oktawian Powązka, L3 Support
IBM License Metric Tool
Original Message:
Sent: Mon December 08, 2025 10:23 AM
From: C Powers
Subject: ILMT REST API in RAML or JSON format
Unfortunately, those REST APIs are not what we are looking for.
We are needing the API definitions for the below API's in RAML or JSON format:
- disconnected_scanner_downloads
- can_results_upload
Thank you,
------------------------------
C Powers
Original Message:
Sent: Thu December 04, 2025 02:38 AM
From: Oktawian Powązka
Subject: ILMT REST API in RAML or JSON format
Hello,
you can use associations to retrieve definitions in json format of most API requests:
https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-rest-associations
------------------------------
Thank you,
Oktawian
Oktawian Powązka, L3 Support
IBM License Metric Tool
Original Message:
Sent: Tue December 02, 2025 10:34 AM
From: C Powers
Subject: ILMT REST API in RAML or JSON format
Was advised to open an 'Open-ended Discussion' as the 'Question to be answered' is having issues with other folks replying to it.
Support -
We have a need to get the API definitions for some ILMT API's in RAML or JASON format.
Could you provide a link to where we can find these?
We have been unable to locate them.
Thank you,
------------------------------
C Powers
------------------------------