systemlink-cli 1.13.5__tar.gz → 1.13.6__tar.gz

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: systemlink-cli
-Version: 1.13.5
+Version: 1.13.6
 Summary: SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates.
 License-File: LICENSE
 Author: Fred Visser

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "systemlink-cli"
-version = "1.13.5"
+version = "1.13.6"
 description = "SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates."
 authors = ["Fred Visser <fred.visser@emerson.com>"]
 packages = [{ include = "slcli" }]

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/_version.py

@@ -1,4 +1,4 @@
 """Version information for slcli."""
 
 # This file is auto-generated. Do not edit manually.
-__version__ = "1.13.5"
+__version__ = "1.13.6"

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/main.py

@@ -64,7 +64,7 @@ def _configure_rich_click_command_groups() -> None:
         "slcli": [
             {
                 "name": "Configure",
-                "commands": ["config", "login", "logout", "info", "completion"],
+                "commands": ["config", "login", "logout", "info", "completion", "example"],
             },
             {
                 "name": "Administer",
@@ -89,7 +89,7 @@ def _configure_rich_click_command_groups() -> None:
             },
             {
                 "name": "Validate & Plan",
-                "commands": ["testmonitor", "template", "spec", "workitem", "example"],
+                "commands": ["testmonitor", "template", "spec", "workitem"],
             },
         ]
     }

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/skills/slcli/SKILL.md

@@ -24,6 +24,16 @@ compatibility: >-
 metadata:
   author: ni-kismet
   version: "2.0"
+---
+
+## Command style
+
+Prefer long option names in generated commands and examples. Use `--format json`,
+`--take 25`, `--workspace Default`, and `--output path.json` instead of `-f json`,
+`-t 25`, `-w Default`, or `-o path.json`.
+
+Only mention short aliases when explicitly documenting that they exist.
+
 #   --system SYSTEM_ID    Assign a system (by minion/system ID). Repeatable.
 #   --fixture ASSET_ID    Assign a fixture/slot (by asset ID, asset type FIXTURE). Repeatable.
 #   --dut ASSET_ID        Assign a DUT (by asset ID, asset type DEVICE_UNDER_TEST). Repeatable.
@@ -36,22 +46,22 @@ slcli workitem schedule <WORK_ITEM_ID> \
   [--system SYSTEM_ID]... [--fixture ASSET_ID]... [--dut ASSET_ID]...
 
 # Work item template subgroup
-slcli workitem template list [-w WORKSPACE] [--filter TEXT] [-t INT] [-f json]
-slcli workitem template get <TEMPLATE_ID> [-f json]
-slcli workitem template create --name TEXT --type TEXT --template-group TEXT [-w WORKSPACE] [OPTIONS]
+slcli workitem template list [--workspace WORKSPACE] [--filter TEXT] [--take INT] [--format json]
+slcli workitem template get <TEMPLATE_ID> [--format json]
+slcli workitem template create --name TEXT --type TEXT --template-group TEXT [--workspace WORKSPACE] [OPTIONS]
 slcli workitem template update <TEMPLATE_ID> [--name TEXT] [--description TEXT] [--summary TEXT]
 slcli workitem template delete <TEMPLATE_ID>... [--yes]
 
 # Workflow subgroup
-slcli workitem workflow list [-w WORKSPACE] [-t INT] [-f json]
-slcli workitem workflow get [--id WORKFLOW_ID] [--name NAME] [-f json]
+slcli workitem workflow list [--workspace WORKSPACE] [--take INT] [--format json]
+slcli workitem workflow get [--id WORKFLOW_ID] [--name NAME] [--format json]
 slcli workitem workflow init [--name TEXT] [--directory DIR]   # Scaffold a local workflow file
-slcli workitem workflow create --file PATH [-w WORKSPACE]      # Create from JSON file
-slcli workitem workflow import --file PATH [-w WORKSPACE]      # Import workflow from JSON
-slcli workitem workflow export [--id WORKFLOW_ID] [--name NAME] [-o FILE]  # Export to JSON
+slcli workitem workflow create --file PATH [--workspace WORKSPACE]      # Create from JSON file
+slcli workitem workflow import --file PATH [--workspace WORKSPACE]      # Import workflow from JSON
+slcli workitem workflow export [--id WORKFLOW_ID] [--name NAME] [--output FILE]  # Export to JSON
 slcli workitem workflow update --id WORKFLOW_ID --file PATH    # Update from JSON file
 slcli workitem workflow delete --id WORKFLOW_ID [--yes]
-slcli workitem workflow preview [--file PATH] [--id WORKFLOW_ID] [--html] [--no-open] [-o FILE]
+slcli workitem workflow preview [--file PATH] [--id WORKFLOW_ID] [--html] [--no-open] [--output FILE]
 ```
 
 **Create work item options:**
@@ -82,9 +92,9 @@ Scaffold, package, and publish custom web applications to SystemLink.
 ```bash
 slcli webapp init <DIRECTORY>                      # Scaffold the Angular starter
 slcli webapp manifest init <DIRECTORY> [OPTIONS]  # Create nipkg.config.json for packaging
-slcli webapp pack [FOLDER] [--config FILE] [-o OUTPUT_FILE]  # Package a webapp into a .nipkg
-slcli webapp list [-w WORKSPACE] [-t INT] [-f json]
-slcli webapp get <WEBAPP_ID> [-f json]
+slcli webapp pack [FOLDER] [--config FILE] [--output OUTPUT_FILE]  # Package a webapp into a .nipkg
+slcli webapp list [--workspace WORKSPACE] [--take INT] [--format json]
+slcli webapp get <WEBAPP_ID> [--format json]
 slcli webapp publish PATH [--workspace NAME]             # Upload and publish a webapp
 slcli webapp delete <WEBAPP_ID>
 slcli webapp open <WEBAPP_ID>                            # Open webapp URL in browser
@@ -95,19 +105,19 @@ slcli webapp open <WEBAPP_ID>                            # Open webapp URL in br
 Create, inspect, import, export, and revert saved software states managed by the SystemLink Systems State service.
 
 ```bash
-slcli state list [-w WORKSPACE] [--architecture CHOICE] [--distribution CHOICE] [-t INT] [-f json]
-slcli state get <STATE_ID> [-f json]
+slcli state list [--workspace WORKSPACE] [--architecture CHOICE] [--distribution CHOICE] [--take INT] [--format json]
+slcli state get <STATE_ID> [--format json]
 slcli state create --name TEXT --distribution CHOICE --architecture CHOICE [OPTIONS]
 slcli state update <STATE_ID> [OPTIONS]
 slcli state delete <STATE_ID> [--yes]
 
 slcli state import --name TEXT --distribution CHOICE --architecture CHOICE --file PATH [OPTIONS]
-slcli state replace-content <STATE_ID> --file PATH [--change-description TEXT] [-f json]
+slcli state replace-content <STATE_ID> --file PATH [--change-description TEXT] [--format json]
 slcli state export <STATE_ID> [--version VERSION] [--inline | --output FILE]
 slcli state capture <SYSTEM_ID> [--inline | --output FILE]
 
-slcli state history <STATE_ID> [-t INT] [-f json]
-slcli state version <STATE_ID> <VERSION> [-f json]
+slcli state history <STATE_ID> [--take INT] [--format json]
+slcli state version <STATE_ID> <VERSION> [--format json]
 slcli state revert <STATE_ID> <VERSION> [--yes]
 ```
 
@@ -148,7 +158,7 @@ Install pre-built demo configurations (systems, assets, DUTs, templates, etc.)
 for training, testing, or evaluation.
 
 ```bash
-slcli example list [-f json]                             # List available examples
+slcli example list [--format json]                       # List available examples
 slcli example info <EXAMPLE_ID>                          # Show example details
 slcli example install <EXAMPLE_ID> [--workspace NAME]    # Provision example resources
 slcli example delete <EXAMPLE_ID> [--workspace NAME]     # Remove provisioned resources
@@ -175,7 +185,7 @@ SystemLink Enterprise (SLE) or require a specific microservice to be deployed.
 
 ```bash
 slcli info                # Shows platform type and service health
-slcli info -f json        # Machine-readable; check .services for per-service status
+slcli info --format json # Machine-readable; check .services for per-service status
 ```
 
 | Command group                | Required service     | SLE | SLS | Notes                                   |
@@ -231,7 +241,7 @@ to disable caching for debugging.
 
 ## Key rules
 
-1. **Always use `-f json`** when piping output to `jq` or doing programmatic analysis.
+1. **Always use `--format json`** when piping output to `jq` or doing programmatic analysis.
 2. **Use `--summary --group-by`** for aggregation instead of fetching all records and counting.
 3. **Use convenience filters first** (e.g., `--status FAILED`), fall back to `--filter` for complex queries.
 4. **Parameterize `--filter` queries** — use `--substitution` instead of string interpolation.

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/skills/systemlink-notebook/SKILL.md

@@ -20,6 +20,84 @@ argument-hint: 'Describe the notebook purpose and what data it should report on'
 - Creating a test data analysis notebook
 - Deploying a notebook to SystemLink via `slcli`
 
+## Important: Python Client Quirks
+
+The `nisystemlink-clients` Python package has a few ergonomics quirks to be aware of:
+
+### API naming inconsistency
+
+Client methods use Python `snake_case`, but request model fields use `camelCase`. This requires careful attention:
+
+```python
+# ❌ WRONG: Using Python snake_case (very intuitive but incorrect)
+CreateResultRequest(program_name="My Test", file_ids=[file_id])
+
+# ✅ CORRECT: Must use camelCase field names from the request model
+CreateResultRequest(programName="My Test", fileIds=[file_id])
+
+# Methods stay snake_case:
+client.create_results(request)  # This is correct
+client.create_steps(...)         # This is correct
+```
+
+Always check the request model constructor signature, not what "feels" Pythonic.
+
+### Partial-success responses
+
+Operations like `create_results()` and `create_steps()` return partial-success wrapper types
+(e.g., `CreateStepsPartialSuccess`) even when successful. These contain both success and failure data:
+
+```python
+from nisystemlink.clients.testmonitor import TestMonitorClient
+from nisystemlink.clients.testmonitor.models import CreateStepRequest
+
+client = TestMonitorClient()
+response = client.create_steps([CreateStepRequest(...)])
+
+# Success and failures are both in the response
+if response.failed:
+    print(f"Failed to create {len(response.failed)} steps")
+if response.created:
+    print(f"Successfully created {len(response.created)} steps")
+```
+
+### Limited service coverage
+
+The Python client does **not cover all SystemLink services**. The most important gaps for notebooks (see the [client repo](https://github.com/ni/nisystemlink-clients-python) for the current full list):
+
+- ❌ **Notebook Execution** — no Python client for execution lifecycle management
+- ❌ **Routines v1/v2** — no Python client for scheduling/triggering
+- ❌ **Systems State** — no Python client for system health queries
+- ❌ **Comments** — no Python client for resource annotations
+- ❌ **User Data** — no Python client for key-value stores
+- ❌ **Tag Historian** — no Python client for time-series history
+
+For these services, use REST calls directly via the `requests` library or SystemLink's OpenAPI SDKs.
+
+### Public import paths
+
+This skill uses two distinct Python SDK namespaces — be careful not to mix them:
+
+- **`nisystemlink.clients.*`** — the typed Python client (`nisystemlink-clients` package). Use public top-level imports.
+- **`systemlink.clients.nisysmgmt.*`** — a separate OpenAPI-generated SDK used only for Systems queries.
+
+For `nisystemlink.clients`, always import from the public top-level modules, not private `_module` paths:
+
+```python
+# ✅ CORRECT: Public paths (nisystemlink-clients)
+from nisystemlink.clients.file import FileClient
+from nisystemlink.clients.testmonitor import TestMonitorClient
+from nisystemlink.clients.testmonitor.models import CreateResultRequest, CreateStepRequest
+
+# ❌ WRONG: Private module paths (may change or be removed)
+from nisystemlink.clients.testmonitor._test_monitor_client import TestMonitorClient
+from nisystemlink.clients.testmonitor.models._create_result_request import CreateResultRequest
+
+# Separate SDK — used only for Systems queries:
+from systemlink.clients.nisysmgmt.api.systems_api import SystemsApi
+from systemlink.clients.nisysmgmt.models.query_systems_request import QuerySystemsRequest
+```
+
 ## Notebook Structure
 
 Every SystemLink notebook follows this cell pattern:
@@ -199,33 +277,59 @@ import scrapbook as sb
 from systemlink.clients.nisysmgmt.api.systems_api import SystemsApi
 from systemlink.clients.nisysmgmt.models.query_systems_request import QuerySystemsRequest
 
-# Test results
+# Test results (remember: camelCase field names in request models)
 from nisystemlink.clients.testmonitor import TestMonitorClient
+from nisystemlink.clients.testmonitor.models import CreateResultRequest, CreateStepRequest
 from nisystemlink.clients.core import HttpConfigurationManager
 
 # Assets
 from nisystemlink.clients.assetmanagement import AssetManagementClient
 
-# Direct HTTP (when no typed client exists)
+# Direct HTTP (when no typed client exists or for missing services)
 import requests
 config = HttpConfigurationManager.get_configuration()
 base_url = config.server_uri.rstrip("/")
-headers = {"x-ni-api-key": config.api_keys[0]}
+api_keys = getattr(config, "api_keys", {})
+api_key = api_keys.get("x-ni-api-key") if isinstance(api_keys, dict) else None
+if not api_key:
+  raise RuntimeError("Configure an x-ni-api-key before using REST fallbacks.")
+headers = {"x-ni-api-key": api_key}
 ```
 
+### Available Python client services
+
+The Python client covers these **15 main services**:
+- `alarm`, `artifact`, `assetmanagement`, `dataframe`, `feeds`, `file`, `notebook`,
+  `notification`, `product`, `spec`, `systems`, `tag`, `test_plan`, `testmonitor`, `work_item`
+
+### Missing services (use REST directly)
+
+If you need these services, call the REST API directly using `requests` and the OpenAPI docs:
+- **Notebook Execution** — execution lifecycle (use OpenAPI directly)
+- **Routines v1/v2** — scheduling/triggering (use OpenAPI directly)
+- **Systems State** — system health/connection status (use OpenAPI directly)
+- **Comments** — resource annotations (use OpenAPI directly)
+- **User Data** — key-value stores (use OpenAPI directly)
+- **Tag Historian** — time-series history (use OpenAPI directly)
+- **Auth**, **User**, and others — see full list in service-gaps documentation
+
 ## Client and API References
 
-- Prefer the official Python client libraries when they cover the target service:
+- **Python client repository** — full source and examples:
   https://github.com/ni/nisystemlink-clients-python
-- If a SystemLink service does not have a Python client yet, call the REST API
-  directly and use the hosted OpenAPI docs to discover endpoints and schemas:
+- **SystemLink OpenAPI docs** — for all services, including those without Python clients:
   https://demo-api.lifecyclesolutions.ni.com/niapis/
-- For notebook patterns and end-to-end examples, check the SystemLink Enterprise
-  examples repository:
+- **SystemLink Enterprise examples** — end-to-end patterns:
   https://github.com/ni/systemlink-enterprise-examples/
 
-When using direct HTTP, prefer the OpenAPI docs first to confirm the service base
-path, request body shape, and response schema before writing notebook code.
+When using the Python client:
+- Always check the request model constructor signature for camelCase field names (they won't match Python snake_case)
+- Expect `create_*` operations to return partial-success wrapper types; inspect `.created` and `.failed` attributes
+- Use public import paths from top-level modules, not private `_module` paths
+
+When a service lacks a Python client, use OpenAPI docs to discover the endpoint path,
+request body shape, and response schema before writing HTTP calls.
+
 ## Systems Query Pattern
 
 The `SystemsApi` uses a projection/filter pattern for querying:

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/skills/systemlink-notebook/references/interfaces.md

@@ -14,6 +14,20 @@ Prefer `create --interface ...` when you are creating a new notebook. Use
 `update --interface ...` for in-place interface changes on an existing notebook.
 Delete and re-create only if the server rejects the update.
 
+## Service Availability Note
+
+The Python client does not cover every SystemLink service. Key gaps that affect
+automation interfaces (see the `nisystemlink-clients` repository for the current
+service list):
+
+- ❌ **Notebook Execution** — No Python client for checking execution status or logs
+- ❌ **Routines v1/v2** — No Python client for scheduling; use REST directly or `slcli routine` in scheduled shells
+- ❌ **Comments** — No Python client for adding resource annotations
+- ❌ **User** — No Python client for querying users/workspaces (use REST directly)
+
+For these services in notebooks, call the REST API directly via the `requests`
+library and the service-specific SystemLink OpenAPI docs.
+
 ## Available Interfaces
 
 | Interface                    | Use Case                                                                                                                                                                                               |
@@ -56,7 +70,12 @@ Parameters typically include:
 ### Periodic Execution
 
 No special parameter requirements. Typically uses fixed configuration
-or reads from tags/files. Can be scheduled via routines:
+or reads from tags/files. Can be scheduled via routines (no Python client available).
+
+**Note:** The Python client does not have a Routines service. Use `slcli routine` to
+schedule notebooks, or call the Routines REST API directly.
+
+Create a scheduled routine via CLI:
 
 ```bash
 slcli routine create --api-version v1 \
@@ -66,6 +85,31 @@ slcli routine create --api-version v1 \
   --schedule '{"startTime":"2026-01-01T00:00:00Z","repeat":"DAY"}'
 ```
 
+Or create a scheduled routine via REST using `HttpConfigurationManager` and `requests`:
+
+```python
+import requests
+from nisystemlink.clients.core import HttpConfigurationManager
+
+config = HttpConfigurationManager.get_configuration()
+base_url = config.server_uri.rstrip("/")
+api_keys = getattr(config, "api_keys", {})
+api_key = api_keys.get("x-ni-api-key") if isinstance(api_keys, dict) else None
+if not api_key:
+    raise RuntimeError("Configure an x-ni-api-key before using REST fallbacks.")
+headers = {"x-ni-api-key": api_key}
+
+payload = {
+    "name": "Daily Report",
+    "type": "SCHEDULED",
+    "notebookId": "<NOTEBOOK_ID>",
+    "schedule": {"startTime": "<START_TIME_ISO8601>", "repeat": "DAY"}
+}
+
+resp = requests.post(f"{base_url}/niroutine/v1/routines", json=payload, headers=headers)
+resp.raise_for_status()
+```
+
 ### Work Item Automations
 
 Use this interface for notebooks that act on selected work items (close, update,
@@ -80,3 +124,49 @@ Parameters are injected by the work item system:
 **Critical:** `work_item_ids` must be typed as `"string[]"` (not `"string"`),
 default to `[]` in both papermill and the code cell, and `systemlink.version`
 must be `1`. See the systemlink-notebook skill for the full metadata example.
+
+**Service note:** The Python client has `work_item` service for querying and updating
+work items, but does not have a `comments` service. If your automation needs to add
+comments or notes, call the Comments REST API directly via `requests` library.
+
+## Using REST When Python Clients Are Missing
+
+If a notebook needs a service without a Python client, use `requests` and the OpenAPI docs:
+
+```python
+import requests
+from nisystemlink.clients.core import HttpConfigurationManager
+
+config = HttpConfigurationManager.get_configuration()
+base_url = config.server_uri.rstrip("/")
+api_keys = getattr(config, "api_keys", {})
+api_key = api_keys.get("x-ni-api-key") if isinstance(api_keys, dict) else None
+if not api_key:
+    raise RuntimeError("Configure an x-ni-api-key before using REST fallbacks.")
+headers = {"x-ni-api-key": api_key}
+
+# Example: Add a comment to a work item (Comments service not available in Python)
+comment_payload = {
+    "resourceId": work_item_id,
+    "resourceType": "WorkItem",
+    "content": "Automated note from notebook"
+}
+
+resp = requests.post(
+    f"{base_url}/nicomments/v1/comments",
+    json=comment_payload,
+    headers=headers
+)
+resp.raise_for_status()
+comment = resp.json()
+```
+
+Common missing services you might need:
+
+- **Comments** — `/nicomments/v1/comments`
+- **Routines v1/v2** — `/niroutine/v1/routines` or `/niroutine/v2/routines`
+- **User** — `/niuser/v1/users` or `/niuser/v1/users/query`
+- **Systems State** — `/nisystemsstate/v1/states`
+- **Tag Historian** — check the service-specific OpenAPI docs instead of assuming `/niapis/...`
+
+Always check the OpenAPI docs to confirm the correct endpoint path and request schema before implementing REST calls.

{systemlink_cli-1.13.5 → systemlink_cli-1.13.6}/slcli/skills/systemlink-notebook/references/notebook-patterns.md

@@ -2,6 +2,10 @@
 
 Annotated examples of common SystemLink notebook patterns.
 
+⚠️ **Important:** The Python client mixes Pythonic `snake_case` method names with `camelCase` request-model field names.
+See the main skill documentation for details on this quirk and other client ergonomics issues. Always verify the
+request model constructor signature before using — intuitive Python names will **not** work.
+
 ---
 
 ## Pattern 1: Systems Grid Column Report
@@ -12,15 +16,19 @@ a `data_frame` output that the Systems Grid can display as a column.
 ### Full annotated example (Package Version)
 
 **Cell 1 — Imports description (markdown)**
+
 ```markdown
 ### Imports
+
 Import Python modules for executing the notebook.
- - Pandas is used for building and handling dataframes.
- - Scrapbook is used for recording data for the Notebook Execution Service.
- - SystemsApi is an NI provided package for communicating with the SystemLink Systems service.
+
+- Pandas is used for building and handling dataframes.
+- Scrapbook is used for recording data for the Notebook Execution Service.
+- SystemsApi is an NI provided package for communicating with the SystemLink Systems service.
 ```
 
 **Cell 2 — Imports (code)**
+
 ```python
 import re
 import pandas as pd
@@ -31,18 +39,21 @@ from systemlink.clients.nisysmgmt.models.query_systems_request import QuerySyste
 ```
 
 **Cell 3 — Parameters description (markdown)**
+
 ```markdown
 ### Parameters
- - `group_by`: The property by which data is grouped. For the data to appear
-   as a column in the Systems Grid, we must support 'System' here.
- - `package`: The Package Name of the software to display the version of.
- - `systems_filter`: A filter specifying which systems to query.
-   An empty filter matches all systems.
+
+- `group_by`: The property by which data is grouped. For the data to appear
+  as a column in the Systems Grid, we must support 'System' here.
+- `package`: The Package Name of the software to display the version of.
+- `systems_filter`: A filter specifying which systems to query.
+  An empty filter matches all systems.
 ```
 
 **Cell 4 — Parameters (code, with metadata)**
 
 The code cell declares variables with defaults:
+
 ```python
 group_by = "System"
 package = "ni-daqmx"
@@ -50,6 +61,7 @@ systems_filter = ""
 ```
 
 The cell metadata must include:
+
 ```json
 {
   "papermill": {
@@ -92,11 +104,13 @@ The cell metadata must include:
 ```
 
 **Cell 5 — Query description (markdown)**
+
 ```markdown
 ### Query for Systems with the specified package and get the Package Version
 ```
 
 **Cell 6 — Query (code)**
+
 ```python
 api = SystemsApi()
 
@@ -133,11 +147,13 @@ data = await query_result
 ```
 
 **Cell 7 — Dataframe description (markdown)**
+
 ```markdown
 ### Extract Package data from query results and create pandas dataframe
 ```
 
 **Cell 8 — Dataframe (code)**
+
 ```python
 pkg_version = { item['id'] : item['displayversion'] for item in data.data }
 df = pd.DataFrame.from_dict(pkg_version, orient='index', columns=['Package Version'])
@@ -145,11 +161,13 @@ df
 ```
 
 **Cell 9 — Output description (markdown)**
+
 ```markdown
 ### Convert dataframe to result format that the Systems Grid can interpret
 ```
 
 **Cell 10 — Output with sb.glue (code)**
+
 ```python
 df_dict = {
     'columns': ['minion id', 'package version'],
@@ -167,8 +185,10 @@ sb.glue('result', result)
 ```
 
 **Cell 11 — Usage instructions (markdown)**
+
 ```markdown
 ### View the output of this report in the Systems Grid
+
 1. Upload this notebook to the reports folder in SystemLink Jupyter
 2. From the Systems page, press the edit grid button
 3. Press '+ ADD' and select 'Notebook' as the data source
@@ -183,7 +203,12 @@ sb.glue('result', result)
 
 Query test results and return a summary. Uses `nisystemlink.clients.testmonitor`.
 
+**⚠️ API Quirk:** Request models in the TestMonitor client use camelCase field names.
+Constructor calls like `CreateResultRequest(programName="...", fileIds=[...])` are required.
+Using intuitive Python `snake_case` names will fail.
+
 **Parameters cell metadata:**
+
 ```json
 {
   "papermill": {
@@ -204,10 +229,22 @@ Query test results and return a summary. Uses `nisystemlink.clients.testmonitor`
       }
     ],
     "parameters": [
-      {"display_name": "Group by", "id": "group_by", "type": "string"},
-      {"display_name": "Program Name", "id": "program_name", "type": "string"},
-      {"display_name": "Status Filter", "id": "status_filter", "type": "string"},
-      {"display_name": "Systems Filter", "id": "systems_filter", "type": "string"}
+      { "display_name": "Group by", "id": "group_by", "type": "string" },
+      {
+        "display_name": "Program Name",
+        "id": "program_name",
+        "type": "string"
+      },
+      {
+        "display_name": "Status Filter",
+        "id": "status_filter",
+        "type": "string"
+      },
+      {
+        "display_name": "Systems Filter",
+        "id": "systems_filter",
+        "type": "string"
+      }
     ],
     "version": 2
   },
@@ -216,6 +253,7 @@ Query test results and return a summary. Uses `nisystemlink.clients.testmonitor`
 ```
 
 **Query pattern:**
+
 ```python
 from nisystemlink.clients.testmonitor import TestMonitorClient
 from nisystemlink.clients.core import HttpConfigurationManager
@@ -231,6 +269,7 @@ results = client.get_results(
 ```
 
 **Output pattern (same as Pattern 1):**
+
 ```python
 result = [{
     "display_name": "Test Summary",
@@ -251,6 +290,7 @@ sb.glue('result', result)
 When the notebook returns a single value instead of a table.
 
 **Output metadata:**
+
 ```json
 {
   "systemlink": {
@@ -266,6 +306,7 @@ When the notebook returns a single value instead of a table.
 ```
 
 **Output code:**
+
 ```python
 result = [{
     "display_name": "Total Count",