retrieve_inventory

This page answers what retrieve_inventory returns, what it takes, and how to read an answer that says a thing is not known.

Purpose

retrieve_inventory reports what exists outside the workspace record, per node: locations, containers, drift, device ids, and the analytics table a warm query reads. With offers: true it adds what the connected cloud offers, such as regions and resource groups. Use get_workspace for what is declared, and call_api with a sample draft for what a container holds.

Inputs

Input	Type	Meaning
kinds	list of text	Keep only these record kinds, such as ["DataConnections"]. Omit it for every active kind.
lookups	list of text	Keep only these record lookups, as get_workspace names them. Omit it for every record.
offers	true or false	Also return the connected cloud's offers. Default false.
includeProposed	true or false	Also return, under Proposals, what each pending proposal of these kinds can know before it is accepted. lookups filters on the proposal's target. Default false.

Example

{ "kinds": ["DataConnections"], "offers": true }

The answer is { Kinds: { <Kind>: { <Lookup>: { Known, Reason?, Facts } } }, Offers? }.

Errors

• An unknown name in kinds is refused with the list of active kinds.
• Known: false means not known, never empty: read its Reason and Remedy.