Skip to main content

Set Node

PUT 

/api/v1/workspaces/:workspaceID/nodes/:nodeID

Replace all fields of a node in a workspace.

Request

Path Parameters

    workspaceID stringrequired

    The environment ID.

    nodeID stringrequired

    The node ID.

Body

required

    oneOf

    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

    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.

  • ]

  • 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

    string

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

    schema stringrequired

    The Snowflake schema name.

Responses

A node for an environment.

Schema

    oneOf

    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

    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.

  • ]

  • 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

    string

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

    schema stringrequired

    The Snowflake schema name.

Loading...