Create Workspace Node

POST 
https://app.coalescesoftware.io/api/v1/workspaces/:workspaceID/nodes

This endpoint will create a new Node with the Workspace default values. 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.

• 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:

Single Node

Multiple Nodes Region and DT_WRK_PART Node IDs were used.

Request

Path Parameters

workspaceID stringrequired

The workspace ID.

application/json

Body

nodeTyperequired

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

Possible values: [Dimension, Fact, Hub, Link, Satellite, Source, Stage, View, persistentStage, string]

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.

Responses

200

application/json

Schema

Schema

oneOf
SourceNode
metadata objectrequired
columns object[]required
Array [
appliedColumnTests object
Will return hasNull or isDistinct as true or false if testing is enabled.
property name*boolean
columnIDstringrequired
The column ID.
columnReferences object[]
Array [
columnNamestringrequired
tableNamestringnullablerequired
]
config object
Returns any configuration options from the Node Config Tab.
property name*any
Returns any configuration options from the Node Config Tab.
dataTypestringrequired
Column data type.
defaultValuestring
The default column value.
descriptionstringrequired
The column description.
hashDetails object
hashAlgorithmHashAlgorithm (string)required
Possible values: [MD5, SHA1, SHA256]
hashTypestring
Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]
hubHashes object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
hashedColumns object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
isBusinessKeyboolean
Tags the column as a business key.
isChangeTrackingboolean
Tags the column as a change tracking column in type 2 dimensions.
isSurrogateKeyboolean
Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.
keyColumnTypestring
Possible values: [None, primaryBusinessKey, surrogateKey]
namestringrequired
The column name.
nullablebooleanrequired
If the column can contain null values.
primaryKeyboolean
Tags the column as a primary key.
sources object[]
Array [
anyOf
SourceColumnReferenceV1
columnReferences object[]required
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
transformstringrequired
Returns the SQL of any column transformations.
SourceColumnReferenceV2
transformstringrequired
Returns the SQL of any column transformations.
]
systemColumnTypestring
Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]
transformstring
uniqueKeyboolean
isSystemCreateDateboolean
isSystemUpdateDateboolean
isSystemStartDateboolean
isSystemEndDateboolean
isSystemVersionboolean
isSystemCurrentFlagboolean
]
join object
joinConditionstringrequired
Returns SQL from the Join tab.
sourceMapping object[]
Array [
aliases object
property name*string
customSQL object
customSQLstringrequired
dependencies object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
join objectrequired
joinConditionstringrequired
namestringrequired
noLinkRefs object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
]
tablestringrequired
databasestringrequired
The Snowflake database name.
descriptionstringrequired
The Node description.
idstringrequired
The Node ID.
locationNamestringrequired
The Storage Mapping location.
namestringrequired
The Node name.
nodeType objectrequired
Either an out of the box Node or a custom Node Type ID or Package Node Type ID
anyOf
MOD1
MOD2
schemastringrequired
The Snowflake schema name.
metadata objectrequired
columns object[]required
Array [
appliedColumnTests object
Will return hasNull or isDistinct as true or false if testing is enabled.
property name*boolean
columnIDstringrequired
The column ID.
columnReferences object[]
Array [
columnNamestringrequired
tableNamestringnullablerequired
]
config object
Returns any configuration options from the Node Config Tab.
property name*any
Returns any configuration options from the Node Config Tab.
dataTypestringrequired
Column data type.
defaultValuestring
The default column value.
descriptionstringrequired
The column description.
hashDetails object
hashAlgorithmHashAlgorithm (string)required
Possible values: [MD5, SHA1, SHA256]
hashTypestring
Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]
hubHashes object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
hashedColumns object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
isBusinessKeyboolean
Tags the column as a business key.
isChangeTrackingboolean
Tags the column as a change tracking column in type 2 dimensions.
isSurrogateKeyboolean
Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.
keyColumnTypestring
Possible values: [None, primaryBusinessKey, surrogateKey]
namestringrequired
The column name.
nullablebooleanrequired
If the column can contain null values.
primaryKeyboolean
Tags the column as a primary key.
sources object[]
Array [
anyOf
SourceColumnReferenceV1
columnReferences object[]required
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
transformstringrequired
Returns the SQL of any column transformations.
SourceColumnReferenceV2
transformstringrequired
Returns the SQL of any column transformations.
]
systemColumnTypestring
Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]
transformstring
uniqueKeyboolean
isSystemCreateDateboolean
isSystemUpdateDateboolean
isSystemStartDateboolean
isSystemEndDateboolean
isSystemVersionboolean
isSystemCurrentFlagboolean
]
join object
joinConditionstringrequired
Returns SQL from the Join tab.
sourceMapping object[]
Array [
aliases object
property name*string
customSQL object
customSQLstringrequired
dependencies object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
join objectrequired
joinConditionstringrequired
namestringrequired
noLinkRefs object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
]
tablestringrequired
SQLNode
config objectrequired
property name* object
anyOf
MOD1
object
MOD2
string
MOD3
number
MOD4
boolean
isMultisourcebooleanrequired
materializationTypeMaterializationType (string)required
Possible values: [table, view]
metadata objectrequired
appliedNodeTests object[]required
Array [
continueOnFailurebooleanrequired
descriptionstringrequired
namestringrequired
runOrderTestRunOrder (string)required
Possible values: [After, Before]
templateStringstringrequired
]
columns object[]required
Array [
appliedColumnTests object
Will return hasNull or isDistinct as true or false if testing is enabled.
property name*boolean
columnIDstringrequired
The column ID.
columnReferences object[]
Array [
columnNamestringrequired
tableNamestringnullablerequired
]
config object
Returns any configuration options from the Node Config Tab.
property name*any
Returns any configuration options from the Node Config Tab.
dataTypestringrequired
Column data type.
defaultValuestring
The default column value.
descriptionstringrequired
The column description.
hashDetails object
hashAlgorithmHashAlgorithm (string)required
Possible values: [MD5, SHA1, SHA256]
hashTypestring
Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]
hubHashes object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
hashedColumns object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
isBusinessKeyboolean
Tags the column as a business key.
isChangeTrackingboolean
Tags the column as a change tracking column in type 2 dimensions.
isSurrogateKeyboolean
Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.
keyColumnTypestring
Possible values: [None, primaryBusinessKey, surrogateKey]
namestringrequired
The column name.
nullablebooleanrequired
If the column can contain null values.
primaryKeyboolean
Tags the column as a primary key.
sources object[]
Array [
anyOf
SourceColumnReferenceV1
columnReferences object[]required
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
transformstringrequired
Returns the SQL of any column transformations.
SourceColumnReferenceV2
transformstringrequired
Returns the SQL of any column transformations.
]
systemColumnTypestring
Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]
transformstring
uniqueKeyboolean
isSystemCreateDateboolean
isSystemUpdateDateboolean
isSystemStartDateboolean
isSystemEndDateboolean
isSystemVersionboolean
isSystemCurrentFlagboolean
]
cteStringstring
descriptionstring
destinationNamestring
enabledColumnTestIDsstring[]required
mapping object
property name* object
anyOf
MOD1
object
MOD2
string
MOD3
number
MOD4
boolean
materializationOptionstring
sourceMapping object[]required
Array [
aliases object
property name*string
customSQL object
customSQLstringrequired
dependencies object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
join objectrequired
joinConditionstringrequired
namestringrequired
noLinkRefs object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
]
overrideSQLbooleanrequired
databasestringrequired
The Snowflake database name.
descriptionstringrequired
The Node description.
idstringrequired
The Node ID.
locationNamestringrequired
The Storage Mapping location.
namestringrequired
The Node name.
nodeType objectrequired
Either an out of the box Node or a custom Node Type ID or Package Node Type ID
anyOf
MOD1
MOD2
schemastringrequired
The Snowflake schema name.
config objectrequired
property name* object
anyOf
MOD1
object
MOD2
string
MOD3
number
MOD4
boolean
isMultisourcebooleanrequired
materializationTypeMaterializationType (string)required
Possible values: [table, view]
metadata objectrequired
appliedNodeTests object[]required
Array [
continueOnFailurebooleanrequired
descriptionstringrequired
namestringrequired
runOrderTestRunOrder (string)required
Possible values: [After, Before]
templateStringstringrequired
]
columns object[]required
Array [
appliedColumnTests object
Will return hasNull or isDistinct as true or false if testing is enabled.
property name*boolean
columnIDstringrequired
The column ID.
columnReferences object[]
Array [
columnNamestringrequired
tableNamestringnullablerequired
]
config object
Returns any configuration options from the Node Config Tab.
property name*any
Returns any configuration options from the Node Config Tab.
dataTypestringrequired
Column data type.
defaultValuestring
The default column value.
descriptionstringrequired
The column description.
hashDetails object
hashAlgorithmHashAlgorithm (string)required
Possible values: [MD5, SHA1, SHA256]
hashTypestring
Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]
hubHashes object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
hashedColumns object[]
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
isBusinessKeyboolean
Tags the column as a business key.
isChangeTrackingboolean
Tags the column as a change tracking column in type 2 dimensions.
isSurrogateKeyboolean
Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.
keyColumnTypestring
Possible values: [None, primaryBusinessKey, surrogateKey]
namestringrequired
The column name.
nullablebooleanrequired
If the column can contain null values.
primaryKeyboolean
Tags the column as a primary key.
sources object[]
Array [
anyOf
SourceColumnReferenceV1
columnReferences object[]required
Array [
columnIDstringrequired
Column ID of the source column.
nodeIDstringrequired
Node ID of the source columm.
]
transformstringrequired
Returns the SQL of any column transformations.
SourceColumnReferenceV2
transformstringrequired
Returns the SQL of any column transformations.
]
systemColumnTypestring
Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]
transformstring
uniqueKeyboolean
isSystemCreateDateboolean
isSystemUpdateDateboolean
isSystemStartDateboolean
isSystemEndDateboolean
isSystemVersionboolean
isSystemCurrentFlagboolean
]
cteStringstring
descriptionstring
destinationNamestring
enabledColumnTestIDsstring[]required
mapping object
property name* object
anyOf
MOD1
object
MOD2
string
MOD3
number
MOD4
boolean
materializationOptionstring
sourceMapping object[]required
Array [
aliases object
property name*string
customSQL object
customSQLstringrequired
dependencies object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
join objectrequired
joinConditionstringrequired
namestringrequired
noLinkRefs object[]required
Array [
locationNamestringrequired
nodeNamestringrequired
]
]
overrideSQLbooleanrequired

Example (auto)

{
  "metadata": {
    "columns": [
      {
        "appliedColumnTests": {},
        "columnID": "string",
        "columnReferences": [
          {
            "columnName": "string",
            "tableName": "string"
          }
        ],
        "config": {},
        "dataType": "string",
        "defaultValue": "string",
        "description": "string",
        "hashDetails": {
          "hashAlgorithm": "MD5",
          "hashType": "ChangeHash",
          "hubHashes": [
            {
              "columnID": "string",
              "nodeID": "string"
            }
          ]
        },
        "hashedColumns": [
          {
            "columnID": "string",
            "nodeID": "string"
          }
        ],
        "isBusinessKey": true,
        "isChangeTracking": true,
        "isSurrogateKey": true,
        "keyColumnType": "None",
        "name": "string",
        "nullable": true,
        "primaryKey": true,
        "sources": [
          {
            "columnReferences": [
              {
                "columnID": "string",
                "nodeID": "string"
              }
            ],
            "transform": "string"
          },
          {
            "transform": "string"
          }
        ],
        "systemColumnType": "None",
        "transform": "string",
        "uniqueKey": true,
        "isSystemCreateDate": true,
        "isSystemUpdateDate": true,
        "isSystemStartDate": true,
        "isSystemEndDate": true,
        "isSystemVersion": true,
        "isSystemCurrentFlag": true
      }
    ],
    "join": {
      "joinCondition": "string"
    },
    "sourceMapping": [
      {
        "aliases": {},
        "customSQL": {
          "customSQL": "string"
        },
        "dependencies": [
          {
            "locationName": "string",
            "nodeName": "string"
          }
        ],
        "join": {
          "joinCondition": "string"
        },
        "name": "string",
        "noLinkRefs": [
          {
            "locationName": "string",
            "nodeName": "string"
          }
        ]
      }
    ]
  },
  "table": "string",
  "database": "string",
  "description": "string",
  "id": "string",
  "locationName": "string",
  "name": "string",
  "schema": "string"
}

Node Response

{
  "metadata": {
    "columns": [
      {
        "appliedColumnTests": {
          "property1": true,
          "property2": true
        },
        "columnID": "string",
        "columnReferences": [
          {
            "columnName": "string",
            "tableName": "string"
          }
        ],
        "config": {},
        "dataType": "string",
        "defaultValue": "string",
        "description": "string",
        "hashDetails": {
          "hashAlgorithm": "MD5",
          "hashType": "ChangeHash",
          "hubHashes": [
            {
              "columnID": "string",
              "nodeID": "string"
            }
          ]
        },
        "hashedColumns": [
          {
            "columnID": "string",
            "nodeID": "string"
          }
        ],
        "isBusinessKey": true,
        "isChangeTracking": true,
        "isSurrogateKey": true,
        "keyColumnType": "None",
        "name": "string",
        "nullable": true,
        "primaryKey": true,
        "sources": [
          {
            "columnReferences": [
              {
                "columnID": "string",
                "nodeID": "string"
              }
            ],
            "transform": "string"
          }
        ],
        "systemColumnType": "None",
        "transform": "string",
        "uniqueKey": true
      }
    ],
    "join": {
      "joinCondition": "string"
    },
    "sourceMapping": [
      {
        "aliases": {
          "property1": "string",
          "property2": "string"
        },
        "customSQL": {
          "customSQL": "string"
        },
        "dependencies": [
          {
            "locationName": "string",
            "nodeName": "string"
          }
        ],
        "join": {
          "joinCondition": "string"
        },
        "name": "string",
        "noLinkRefs": [
          {
            "locationName": "string",
            "nodeName": "string"
          }
        ]
      }
    ]
  },
  "table": "string",
  "database": "string",
  "description": "string",
  "id": "string",
  "locationName": "string",
  "name": "string",
  "nodeType": "Dimension",
  "schema": "string"
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

Authorization: http

name: BearerAuthtype: httpscheme: bearer

• curl
• python
• powershell
• php
• nodejs
• r
• javascript

• CURL

Request Collapse all

Base URL

https://app.coalescesoftware.io

Auth

Bearer Token

Parameters

workspaceID — pathrequired

Body

{
  "predecessorNodeIDs": [
    "string"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!