List Environment Nodes

GET 
https://app.coalescesoftware.io/api/v1/environments/:environmentID/nodes

Get a collection of Nodes for an Environment.

Request

Path Parameters

environmentID stringrequired

The environment ID.

Query Parameters

detail boolean
Include the full detail of the nodes.
Default value: false
limit integer
Possible values: >= 1 and <= 500
The maximum number of Nodes to return. Between 1 and 500.
Default value: 100
startingFrom string

The cursor point for paging the query results.

orderBy string
The field to order the results by. Only id allowed.
Default value: id

Responses

200

application/json

Schema

Schema

data objectrequired

anyOf

MOD1

Array [

databasestringrequired

The Snowflake database name.

idstringrequired

The Coalesce 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 database schema name.

]

MOD2

Array [

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

]

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

]

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

]

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

]

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

]

totalinteger

The size of the result set.

startingFromstring

The cursor value used in the request.

limitinteger

The requested page size.

nextstring

The field value where the next page of result starts after.

orderBystring

The field to order the results by. Only id allowed.

Example (auto)

{
  "data": [
    {
      "database": "string",
      "id": "string",
      "locationName": "string",
      "name": "string",
      "schema": "string"
    }
  ],
  "total": 0,
  "startingFrom": "string",
  "limit": 0,
  "next": "string",
  "orderBy": "string"
}

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 objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Invalid Request Error

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

401

User lacks authorization to perform this action.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Unauthorized

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

403

The client is not permitted to perform the requested operation.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Forbidden Error

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

404

The requested resource could not be found.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

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 objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Internal Server Error

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

502

The server received an error from an upstream system.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Bad Gateway Error

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

503

The service is currently unavailable.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

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 objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

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

Gateway Timeout Error

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

Authorization: http

name: BearerAuthtype: httpscheme: bearer

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

• CURL

curl -L 'https://app.coalescesoftware.io/api/v1/environments/:environmentID/nodes' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://app.coalescesoftware.io

Auth

Bearer Token

Parameters

environmentID — pathrequired

detail — query

---truefalse

limit — query

startingFrom — query

orderBy — query

ResponseClear

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