Nodes

Create Workspace Node

Create a new Workspace Node with the specified configuration.

To update or change the Node data use the Set Node endpoint.

Get the Node Type

You can get the nodeType in two ways:

  • Look up the nodeType in the Coalesce App. Go to Build Settings > Node Types, then click View. At the top you'll see the nodeTypeID. This is your nodeType. If the is this: nodeTypeID: externalDataPackage:::372, you'll use: nodeType: externalDataPackage:::372.
<img src="/img/docs-images/nodetype_in_app.png" alt="" className="mdImages" width="50%"/>
  • You can use the List Environment Nodes or List Workspace Nodes to get a list of existing Nodes. This endpoint only returns in use Nodes and Node types. For example, if you have Node type ML Forecast and ML Anomaly Detection installed, but you are only using ML Forecast, ML Anomaly Node type won't return in the API results.

Using predecessorNodeIDs

You can leave it blank, enter a single Node ID or multiple Node IDs.

Blank: <img src="/img/docs-images/blank_predecessor.png" alt="" className="mdImages"/>

Single Node <img src="/img/docs-images/single_predecessor.png" alt="" className="mdImages"/>

Multiple Nodes Region and DT_WRK_PART Node IDs were used. <img src="/img/docs-images/multiple_predecessor.png" alt="" className="mdImages"/>

post/api/v1/workspaces/{workspaceID}/nodes

Request

  • Base URL: https://app.coalescesoftware.io
  • URL: https://app.coalescesoftware.io/api/v1/workspaces/{workspaceID}/nodes
  • Auth: HTTP bearer

Request body

nodeType'Dimension' | 'Fact' | 'Hub' | 'Link' | 'Satellite' | 'Source' | 'Stage' | 'View' | 'persistentStage' | 'string' required

Accepts any of the Coalesce out of the box Node Types, or you can enter a nodeTypeID for custom and package Nodes.

predecessorNodeIDsstring[] required

Enter an array of Node IDs if they should be the predecessor to the newly created Node. Leave array empty if there is no predecessor.

Response

OR

Example response

{
  "nodeType": "externalDataPackage:::372"
}

Changes

No recorded changes to this operation across all 1 revision of this API.