Static Endpoints

Static endpoints return the contents of a file stored next to the endpoint configuration.

Configuration ​

Each endpoint is a folder endpoints/Static/{EndpointName}/ with entity.json and the content file:

endpoints/Static/ProductionMachine/
├── entity.json
└── summary.xml

Contents of entity.json:

{
  "ContentType": "application/xml",
  "ContentFile": "summary.xml",
  "EnableFiltering": true,
  "Hidden": false,
  "AllowedEnvironments": ["prod", "dev"],
  "Documentation": {
    "TagDescription": "Production machine data",
    "MethodDescriptions": {
      "GET": "Retrieve machine details"
    }
  }
}

All properties, types and defaults: Entity configuration.

Supported content types ​

OData filtering ​

With EnableFiltering: true, static endpoints accept the same OData options as SQL endpoints:

GET /api/prod/ProductionMachine?$filter=status eq 'running'&$top=5&$orderby=name
GET /api/prod/ProductionMachine?$select=id,name,status

Filtered responses include these headers:

• X-Filtering-Status: Applied
• X-Total-Count: item count before filtering
• X-Returned-Count: item count after filtering

Next steps ​

• SQL Endpoints
• Environments