List Workspace Nodes

GET 
/api/v1/workspaces/:workspaceID/nodes

Get a collection of nodes for a workspace.

Request

Path Parameters

workspaceID stringrequired

The workspace ID.

Query Parameters

detail boolean

Include the full detail of the nodes.

Responses

200

A collection of nodes for an environment.

application/json

Schema

Schema

data

object

required

A collection of nodes for an environment.

anyOf

MOD1

Array [

database stringrequired

The Snowflake database name.

id stringrequired

The Coalesce Node ID.

locationName stringrequired

The Storage Mapping location.

name stringrequired

The Node name.

nodeType

object

required

anyOf

MOD1

string

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

MOD2

string

schema stringrequired

The database schema name.

]

MOD2

Array [

oneOf

SourceNode

metadata

object

required

columns

object[]

required

Array [

appliedColumnTests

object

Will return hasNull or isDistinct as true or false if testing is enabled.

property name* boolean

columnID stringrequired

The column ID.

columnReferences

object[]

Array [

columnName stringrequired

tableName stringnullablerequired

]

config

object

Returns any configuration options from the Node Config Tab.

property name* any

Returns any configuration options from the Node Config Tab.

dataType stringrequired

Column data type.

defaultValue string

The default column value.

description stringrequired

The column description.

hashDetails

object

hashAlgorithm HashAlgorithm (string)required

Possible values: [MD5, SHA1, SHA256]

hashType string

Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]

hubHashes

object[]

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

hashedColumns

object[]

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

isBusinessKey boolean

Tags the column as a business key.

isChangeTracking boolean

Tags the column as a change tracking column in type 2 dimensions.

isSurrogateKey boolean

Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.

keyColumnType string

Possible values: [None, primaryBusinessKey, surrogateKey]

name stringrequired

The column name.

nullable booleanrequired

If the column can contain null values.

primaryKey boolean

Tags the column as a primary key.

sources

object[]

Array [

anyOf

SourceColumnReferenceV1

columnReferences

object[]

required

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

transform stringrequired

Returns the SQL of any column transformations.

SourceColumnReferenceV2

transform stringrequired

Returns the SQL of any column transformations.

]

systemColumnType string

Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]

transform string

uniqueKey boolean

]

join

object

joinCondition stringrequired

Returns SQL from the Join tab.

sourceMapping

object[]

Array [

aliases

object

property name* string

customSQL

object

customSQL stringrequired

dependencies

object[]

required

Array [

locationName stringrequired

nodeName stringrequired

]

join

object

required

joinCondition stringrequired

name stringrequired

noLinkRefs

object[]

required

Array [

locationName stringrequired

nodeName stringrequired

]

]

table stringrequired

property name* any

database stringrequired

The Snowflake database name.

description stringrequired

The Node description.

id stringrequired

The Node ID.

locationName stringrequired

The Storage Mapping location.

name stringrequired

The Node name.

nodeType

object

required

anyOf

MOD1

string

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

MOD2

string

schema stringrequired

The Snowflake schema name.

SQLNode

config

object

required

property name*

object

anyOf

MOD1

object

MOD2

string

MOD3

number

MOD4

boolean

isMultisource booleanrequired

materializationType MaterializationType (string)required

Possible values: [table, view]

metadata

object

required

appliedNodeTests

object[]

required

Array [

continueOnFailure booleanrequired

description stringrequired

name stringrequired

runOrder TestRunOrder (string)required

Possible values: [After, Before]

templateString stringrequired

]

columns

object[]

required

Array [

appliedColumnTests

object

Will return hasNull or isDistinct as true or false if testing is enabled.

property name* boolean

columnID stringrequired

The column ID.

columnReferences

object[]

Array [

columnName stringrequired

tableName stringnullablerequired

]

config

object

Returns any configuration options from the Node Config Tab.

property name* any

Returns any configuration options from the Node Config Tab.

dataType stringrequired

Column data type.

defaultValue string

The default column value.

description stringrequired

The column description.

hashDetails

object

hashAlgorithm HashAlgorithm (string)required

Possible values: [MD5, SHA1, SHA256]

hashType string

Possible values: [ChangeHash, Hash, HubHash, LinkHash, None]

hubHashes

object[]

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

hashedColumns

object[]

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

isBusinessKey boolean

Tags the column as a business key.

isChangeTracking boolean

Tags the column as a change tracking column in type 2 dimensions.

isSurrogateKey boolean

Tags the column as a surrogate key, e.g. DIM_CUSTOMER_KEY.

keyColumnType string

Possible values: [None, primaryBusinessKey, surrogateKey]

name stringrequired

The column name.

nullable booleanrequired

If the column can contain null values.

primaryKey boolean

Tags the column as a primary key.

sources

object[]

Array [

anyOf

SourceColumnReferenceV1

columnReferences

object[]

required

Array [

columnID stringrequired

Column ID of the source column.

nodeID stringrequired

Node ID of the source columm.

]

transform stringrequired

Returns the SQL of any column transformations.

SourceColumnReferenceV2

transform stringrequired

Returns the SQL of any column transformations.

]

systemColumnType string

Possible values: [None, sysCreateDate, sysCurrentFlag, sysEndDate, sysStartDate, sysUpdateDate, sysVersion]

transform string

uniqueKey boolean

]

cteString string

description string

destinationName string

enabledColumnTestIDs string[]required

mapping

object

property name*

object

anyOf

MOD1

object

MOD2

string

MOD3

number

MOD4

boolean

materializationOption string

sourceMapping

object[]

required

Array [

aliases

object

property name* string

customSQL

object

customSQL stringrequired

dependencies

object[]

required

Array [

locationName stringrequired

nodeName stringrequired

]

join

object

required

joinCondition stringrequired

name stringrequired

noLinkRefs

object[]

required

Array [

locationName stringrequired

nodeName stringrequired

]

]

overrideSQL booleanrequired

property name* any

database stringrequired

The Snowflake database name.

description stringrequired

The Node description.

id stringrequired

The Node ID.

locationName stringrequired

The Storage Mapping location.

name stringrequired

The Node name.

nodeType

object

required

anyOf

MOD1

string

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

MOD2

string

schema stringrequired

The Snowflake schema name.

]

Nodes Response

{
  "data": [
    {
      "database": "string",
      "id": "string",
      "locationName": "string",
      "name": "string",
      "nodeType": "Dimension",
      "schema": "string"
    }
  ]
}

400

The request was invalid.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Invalid Request Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

401

User lacks authorization to perform this action.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Unauthorized

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

403

The client is not permitted to perform the requested operation.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Forbidden Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

404

The requested resource could not be found.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Not Found Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

500

The server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Internal Server Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

502

The server received an error from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Bad Gateway Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

503

The service is currently unavailable.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Service Unavailable Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

504

The server did not receive a response in time from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Gateway Timeout Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Loading...