API to demonstrate the use of x-playground-example extension
Servers
https://api.example.com/v1Production server
List items with playground-specific examples
GET
/items
Demonstrates the use of x-playground-example extension.
Parameters
Header Parameters
X-Custom
Optionally provide parameters as a JSON object in this header.
Type
string
Example
{"id":"header-id-789"}X-Api-Key*
API key for authentication
Type
Requiredstring
Example
"api-key-123"Query Parameters
id
Filter by ID (with playground-specific example)
Type
string
Example
"general-id-456"name
Filter by name (with schema-level playground example)
Type
string
Example
"General Item Name"category
Filter by category (with standard example)
Type
string
Example
"electronics"filters
Filter criteria for fetching device points.
Type
string
Examples
{
"limit": 10,
"order": [
"timestamp DESC"
]
}{
"where": {
"type": "temp"
},
"limit": 10,
"order": [
"timestamp DESC"
]
}{
"where": {
"type": "temp",
"timestamp": {
"between": [
"2024-12-01T00:00:00.000Z",
"2024-12-01T23:59:59.999Z"
]
}
},
"order": [
"timestamp DESC"
]
}{"limit":10,"order":["timestamp ASC"]}{"where":{"timestamp":{"between":["2024-12-01T00:00:00.000Z","2024-12-01T23:59:59.999Z"]}},"order":["timestamp DESC"]}{"where":{"correlationId":"abc123"}}Format
"JSON"Responses
Successful response
application/json