Nodes, Workflows, and Products

Every kind of item has an endpoint that returns it in detail. The answer for a node is the richest one: it holds what the node page on nodepit.com shows, in a form that a script can read. This page goes through it field by field, and then covers the other kinds of items.

What a node answer contains

The answer for /api/nodes/{nodePitId} has many fields. These are the ones that people use most:

• name, description, and intro — the name, the short description from the node’s own documentation, and the longer introduction as HTML.
• inPorts and outPorts — the ports in order, each with its name, a description, and whether it is optional. Nodes with a variable number of ports list those as dynamicInPorts and dynamicOutPorts.
• options and optionTabs — the settings of the node’s dialog, as the node’s documentation describes them. Nodes whose dialog has tabs list their settings per tab in optionTabs and leave options empty.
• path — where the node sits in the node repository, from the root category down.
• featureName, featureNodePitId, and updateSiteUrl — the extension that provides the node and the update site to install it from. This is what answers “what do I have to install to get this node?”
• deprecated and replacedByNodePitId — whether KNIME has deprecated the node, and the node that replaces it if there is one. Deprecated nodes usually keep working, but they no longer get new features.
• predecessors and successors — the nodes connected before and after this one in public workflows, each with a count of how often. Sort by the count to see what people usually do with a node.
• iconBase64 — the icon of the node as a PNG image, encoded in Base64. For an icon to show on a page, use the node images instead.

Ask for a version with knimeVersion to see the node as it is in that KNIME release. Concepts explains how versions work.

Categories and extensions

A node sits in a category and ships in an extension, and each has an endpoint of its own. /api/categories/{nodePitId} returns the description of a category, the categories above it, and the extension that provides it. /api/features/{nodePitId} returns an extension with the update site to install it from.

The ID of the extension is in the answer for the node as featureNodePitId, so one more request leads you from a node to everything about the extension that ships it.

Workflows

/api/workflows/{nodePitId} returns a public workflow or component. component tells the two apart, nodes lists the nodes it uses, each with its nodePitId and the annotation it has in the workflow, and downloadUrl is where to download it. The IDs in nodes are the ones to ask /api/nodes about, for example to find the extensions a workflow needs.

Workflows do not depend on a KNIME version, so this endpoint takes no knimeVersion.

Products

A product is what a vendor offers on NodePit: one or more extensions, with a product page. /api/products/{nodePitId} returns its description, the longer text of its page, its latest version with the releaseDate, its downloadCount, and in features the extensions it consists of. /api/products lists all products in one answer.

Put it to work

The guides show requests built on these fields: finding the extension a node needs, checking whether it is deprecated, seeing what usually follows it, and starting from a public workflow.