Update display metadata of one catalog node.

PUT

/api/workspace/catalogs/{catalogDefinitionId}/nodes/{nodeId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/catalogs/example/nodes/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"DisplayName\": \"example\", \"Description\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/catalogs/example/nodes/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"DisplayName":"example","Description":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/catalogs/example/nodes/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "DisplayName": "example", "Description": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

catalogDefinitionId

required

string

nodeId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Update display metadata of one catalog node. The node key and path stay unchanged.

object

DisplayName

New node display name.

string

nullable

Description

Optional free-form description.

string

nullable

RowVersion

Expected concurrency token.

string format: uuid

Example^generated

{
  "DisplayName": "example",
  "Description": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update display metadata of one catalog node. The node key and path stay unchanged.

object

DisplayName

New node display name.

string

nullable

Description

Optional free-form description.

string

nullable

RowVersion

Expected concurrency token.

string format: uuid

Example^generated

{
  "DisplayName": "example",
  "Description": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Update display metadata of one catalog node. The node key and path stay unchanged.

object

DisplayName

New node display name.

string

nullable

Description

Optional free-form description.

string

nullable

RowVersion

Expected concurrency token.

string format: uuid

Example^generated

{
  "DisplayName": "example",
  "Description": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

One runtime catalog node.

object

Node identifier.

string

nullable

CatalogDefinitionId

Owning catalog definition identifier.

string

nullable

NodeTypeId

Catalog node type definition identifier for entity-backed hierarchies.

string

nullable

ParentNodeId

Parent node identifier or null for root nodes.

string

nullable

Key

Stable sibling key generated at create time.

string

nullable

DisplayName

Node display name.

string

nullable

Description

Optional free-form description.

string

nullable

PathNodeIds

Ordered identifier path from the top-level node through this node.

Array<string>

nullable

Breadcrumbs

Display breadcrumb segments resolved from current node metadata.

Array<object>

nullable

One display breadcrumb segment for a catalog node.

object

NodeId

Node identifier.

string

nullable

DisplayName

Current node display name.

string

nullable

Depth

Zero-based tree depth.

integer format: int32

SortOrder

Sibling sort order.

integer format: int32

ChildCount

Number of direct child nodes.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

CreatedAt

Node creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

One runtime catalog node.

object

Node identifier.

string

nullable

CatalogDefinitionId

Owning catalog definition identifier.

string

nullable

NodeTypeId

Catalog node type definition identifier for entity-backed hierarchies.

string

nullable

ParentNodeId

Parent node identifier or null for root nodes.

string

nullable

Key

Stable sibling key generated at create time.

string

nullable

DisplayName

Node display name.

string

nullable

Description

Optional free-form description.

string

nullable

PathNodeIds

Ordered identifier path from the top-level node through this node.

Array<string>

nullable

Breadcrumbs

Display breadcrumb segments resolved from current node metadata.

Array<object>

nullable

One display breadcrumb segment for a catalog node.

object

NodeId

Node identifier.

string

nullable

DisplayName

Current node display name.

string

nullable

Depth

Zero-based tree depth.

integer format: int32

SortOrder

Sibling sort order.

integer format: int32

ChildCount

Number of direct child nodes.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

CreatedAt

Node creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

One runtime catalog node.

object

Node identifier.

string

nullable

CatalogDefinitionId

Owning catalog definition identifier.

string

nullable

NodeTypeId

Catalog node type definition identifier for entity-backed hierarchies.

string

nullable

ParentNodeId

Parent node identifier or null for root nodes.

string

nullable

Key

Stable sibling key generated at create time.

string

nullable

DisplayName

Node display name.

string

nullable

Description

Optional free-form description.

string

nullable

PathNodeIds

Ordered identifier path from the top-level node through this node.

Array<string>

nullable

Breadcrumbs

Display breadcrumb segments resolved from current node metadata.

Array<object>

nullable

One display breadcrumb segment for a catalog node.

object

NodeId

Node identifier.

string

nullable

DisplayName

Current node display name.

string

nullable

Depth

Zero-based tree depth.

integer format: int32

SortOrder

Sibling sort order.

integer format: int32

ChildCount

Number of direct child nodes.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

CreatedAt

Node creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

One runtime catalog node.

object

Node identifier.

string

nullable

CatalogDefinitionId

Owning catalog definition identifier.

string

nullable

NodeTypeId

Catalog node type definition identifier for entity-backed hierarchies.

string

nullable

ParentNodeId

Parent node identifier or null for root nodes.

string

nullable

Key

Stable sibling key generated at create time.

string

nullable

DisplayName

Node display name.

string

nullable

Description

Optional free-form description.

string

nullable

PathNodeIds

Ordered identifier path from the top-level node through this node.

Array<string>

nullable

Breadcrumbs

Display breadcrumb segments resolved from current node metadata.

Array<object>

nullable

One display breadcrumb segment for a catalog node.

object

NodeId

Node identifier.

string

nullable

DisplayName

Current node display name.

string

nullable

Depth

Zero-based tree depth.

integer format: int32

SortOrder

Sibling sort order.

integer format: int32

ChildCount

Number of direct child nodes.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

CreatedAt

Node creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Update display metadata of one catalog node.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated

Example^generated

Example^generated

Example^generated