Guide contents

study_equipment

Purpose and availability

Discover native equipment IDs, units, supported study kinds, readiness, scenarios and parameter provenance. Read-only, no calculation. Page a category before building a request; use the returned artifact as expected_artifact.

Before invocation

Inspect the current definition and exact version/project binding before invoking. Required fields, enums, bounds and consent fields below are authoritative. Omit no required input and do not invent unavailable values.

Exact input schema

{
  "additionalProperties": false,
  "properties": {
    "case_id": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "category": {
      "enum": [
        "summary",
        "buses",
        "branches",
        "loads",
        "generators",
        "scenarios",
        "times",
        "findings",
        "parameter_sources"
      ]
    },
    "limit": {
      "maximum": 200,
      "minimum": 1,
      "type": "integer"
    },
    "offset": {
      "minimum": 0,
      "type": "integer"
    },
    "receipt": {
      "pattern": "^[a-f0-9]{64}$",
      "type": "string"
    },
    "scenario": {
      "type": "integer"
    },
    "version": {
      "pattern": "^[a-f0-9]{64}$",
      "type": "string"
    }
  },
  "required": [],
  "type": "object"
}

Results, errors and safety

Inspect the structured result and retained IDs/artifacts. Errors, unsupported profiles, missing data and cancellation remain explicit. A successful call grants no human engineering approval. Do not retry inference automatically. See Workflows, History and Project tools.