Kumiho Action icon

Kumiho Action

Create, read, update, or delete Kumiho resources.

Actions28

Item → Read

AI-generated

Summary

Retrieve items by Kref, path, or search filters.

Inputs

  • readModeItem — Select how to retrieve the item(s). Default: itemGet. Options: Get Item (by Kref), Get Item (by Name / Kind), Search Items. Shown when resource=item and operation=read.
  • itemKrefItem — Item Kref in format kref://project/space/item.kind. Required when readModeItem=itemGet. Shown when readModeItem=itemGet.
  • itemSpacePath — Space path in format /project/space. Required when readModeItem=itemGetByPath. Shown when readModeItem=itemGetByPath.
  • itemName — Item name. Required when readModeItem=itemGetByPath. Shown when readModeItem=itemGetByPath.
  • itemKind — Item kind. Default: model. Shown when readModeItem=itemGetByPath.
  • contextFilter — Context filter for search. Shown when readModeItem=itemSearch.
  • nameFilter — Name filter for search. Shown when readModeItem=itemSearch.
  • kindFilter — Kind filter for search. Shown when readModeItem=itemSearch.
  • outputFormatItem — Output format for search results. Default: split. Options: Split Into Items, Single Item (Array). Shown when readModeItem=itemSearch.
  • returnAllItem — Whether to return all results or apply limit. Default: true. Shown when readModeItem=itemSearch.
  • limitItem — Maximum number of items to return. Default: 100, minimum: 1. Shown when readModeItem=itemSearch and returnAllItem=false.

Output shape

Depends on readMode selected:

All outputs are arrays of JSON objects pushed via the node's emitArray helper, respecting outputFormat, returnAll, and limit settings where applicable.

Examples

Example 1: readModeItem=itemGet with itemKrefItem=kref://project/space/item.kind

Makes a GET request to /api/v1/items/by-kref?kref=kref://project/space/item.kind and returns the single item as one output JSON object.

Example 2: readModeItem=itemGetByPath with itemSpacePath=/project/space, itemName=my-model, itemKind=model

Makes a GET request to /api/v1/items/by-path?space_path=%2Fproject%2Fspace&item_name=my-model&kind=model and returns the single item as one output JSON object.

Example 3: readModeItem=itemSearch with contextFilter=some-context, nameFilter=, kindFilter=

Makes a GET request to /api/v1/items/search?context_filter=some-context&name_filter=&kind_filter= and returns an array of items. Output format and count are controlled by outputFormatItem, returnAllItem, and limitItem.

Links

Discussion