Update one catalog definition.

PUT

/api/workspace/admin/catalogs/{catalogDefinitionId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/catalogs/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"CatalogAdministratorRoleIds\": [ \"example\" ], \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"CatalogReaderRoleIds\": [ \"example\" ] }")
    {
        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/admin/catalogs/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Key":"example","DisplayName":"example","Description":"example","CatalogAdministratorRoleIds":["example"],"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","CatalogReaderRoleIds":["example"]}'
};

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/admin/catalogs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "CatalogAdministratorRoleIds": [ "example" ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "CatalogReaderRoleIds": [ "example" ] }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

catalogDefinitionId

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 one catalog definition.

object

Key

Stable technical key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

CatalogAdministratorRoleIds

Roles allowed to read and administer the catalog tree at runtime.

Array<string>

nullable

RowVersion

Expected concurrency token.

string format: uuid

CatalogReaderRoleIds

Roles allowed to read the catalog at runtime.

Array<string>

nullable

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "CatalogAdministratorRoleIds": [
    "example"
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "CatalogReaderRoleIds": [
    "example"
  ]
}

Update one catalog definition.

object

Key

Stable technical key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

CatalogAdministratorRoleIds

Roles allowed to read and administer the catalog tree at runtime.

Array<string>

nullable

RowVersion

Expected concurrency token.

string format: uuid

CatalogReaderRoleIds

Roles allowed to read the catalog at runtime.

Array<string>

nullable

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "CatalogAdministratorRoleIds": [
    "example"
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "CatalogReaderRoleIds": [
    "example"
  ]
}

Update one catalog definition.

object

Key

Stable technical key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

CatalogAdministratorRoleIds

Roles allowed to read and administer the catalog tree at runtime.

Array<string>

nullable

RowVersion

Expected concurrency token.

string format: uuid

CatalogReaderRoleIds

Roles allowed to read the catalog at runtime.

Array<string>

nullable

Example^generated

{
  "Key": "example",
  "DisplayName": "example",
  "Description": "example",
  "CatalogAdministratorRoleIds": [
    "example"
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "CatalogReaderRoleIds": [
    "example"
  ]
}

Responses

200

application/json

object

Data

Full catalog definition detail for admin editing.

object

Catalog definition identifier.

string

nullable

Key

Stable catalog key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SecurityMode

integer format: int32

Allowed values: 0 1

CatalogAdministratorRoles

Roles allowed to read and administer the catalog tree at runtime.

Array<object>

nullable

One role allowed to administer root catalog folders at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

CatalogReaderRoles

Roles allowed to read the catalog at runtime.

Array<object>

nullable

One role allowed to read a catalog at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

TargetEntityDefinitionCount

Number of entity definitions admitted into the catalog.

integer format: int32

Targets

Entity definitions admitted into the catalog.

Array<object>

nullable

One entity definition admitted into a catalog definition.

object

Catalog target identifier.

string

nullable

CatalogDefinitionId

Catalog definition identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionName

Entity definition technical name.

string

nullable

EntityDefinitionDisplayNameSingular

Entity definition singular display name.

string

nullable

EntityDefinitionDisplayNamePlural

Entity definition plural display name.

string

nullable

UsageType

integer format: int32

Allowed values: 0 1 2

ListFields

Configured compact list projection fields.

Array<object>

nullable

One configured compact list projection field for a catalog target.

object

Catalog target list field identifier.

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

Provider or entity field key.

string

nullable

DisplayName

Default display name.

string

nullable

DisplayNameOverride

Optional target-specific display name.

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

SortOrder

Display order.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

SortOrder

Display order in the catalog definition.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

RowVersion

Concurrency token.

string format: uuid

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

{
  "Data": {
    "Kind": 0,
    "SecurityMode": 0,
    "Targets": [
      {
        "UsageType": 0,
        "ListFields": [
          {
            "SourceKind": 0,
            "ValueType": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Full catalog definition detail for admin editing.

object

Catalog definition identifier.

string

nullable

Key

Stable catalog key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SecurityMode

integer format: int32

Allowed values: 0 1

CatalogAdministratorRoles

Roles allowed to read and administer the catalog tree at runtime.

Array<object>

nullable

One role allowed to administer root catalog folders at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

CatalogReaderRoles

Roles allowed to read the catalog at runtime.

Array<object>

nullable

One role allowed to read a catalog at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

TargetEntityDefinitionCount

Number of entity definitions admitted into the catalog.

integer format: int32

Targets

Entity definitions admitted into the catalog.

Array<object>

nullable

One entity definition admitted into a catalog definition.

object

Catalog target identifier.

string

nullable

CatalogDefinitionId

Catalog definition identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionName

Entity definition technical name.

string

nullable

EntityDefinitionDisplayNameSingular

Entity definition singular display name.

string

nullable

EntityDefinitionDisplayNamePlural

Entity definition plural display name.

string

nullable

UsageType

integer format: int32

Allowed values: 0 1 2

ListFields

Configured compact list projection fields.

Array<object>

nullable

One configured compact list projection field for a catalog target.

object

Catalog target list field identifier.

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

Provider or entity field key.

string

nullable

DisplayName

Default display name.

string

nullable

DisplayNameOverride

Optional target-specific display name.

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

SortOrder

Display order.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

SortOrder

Display order in the catalog definition.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

RowVersion

Concurrency token.

string format: uuid

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

{
  "Data": {
    "Kind": 0,
    "SecurityMode": 0,
    "Targets": [
      {
        "UsageType": 0,
        "ListFields": [
          {
            "SourceKind": 0,
            "ValueType": 0
          }
        ]
      }
    ]
  },
  "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

Full catalog definition detail for admin editing.

object

Catalog definition identifier.

string

nullable

Key

Stable catalog key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SecurityMode

integer format: int32

Allowed values: 0 1

CatalogAdministratorRoles

Roles allowed to read and administer the catalog tree at runtime.

Array<object>

nullable

One role allowed to administer root catalog folders at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

CatalogReaderRoles

Roles allowed to read the catalog at runtime.

Array<object>

nullable

One role allowed to read a catalog at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

TargetEntityDefinitionCount

Number of entity definitions admitted into the catalog.

integer format: int32

Targets

Entity definitions admitted into the catalog.

Array<object>

nullable

One entity definition admitted into a catalog definition.

object

Catalog target identifier.

string

nullable

CatalogDefinitionId

Catalog definition identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionName

Entity definition technical name.

string

nullable

EntityDefinitionDisplayNameSingular

Entity definition singular display name.

string

nullable

EntityDefinitionDisplayNamePlural

Entity definition plural display name.

string

nullable

UsageType

integer format: int32

Allowed values: 0 1 2

ListFields

Configured compact list projection fields.

Array<object>

nullable

One configured compact list projection field for a catalog target.

object

Catalog target list field identifier.

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

Provider or entity field key.

string

nullable

DisplayName

Default display name.

string

nullable

DisplayNameOverride

Optional target-specific display name.

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

SortOrder

Display order.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

SortOrder

Display order in the catalog definition.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

RowVersion

Concurrency token.

string format: uuid

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

{
  "Data": {
    "Kind": 0,
    "SecurityMode": 0,
    "Targets": [
      {
        "UsageType": 0,
        "ListFields": [
          {
            "SourceKind": 0,
            "ValueType": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Full catalog definition detail for admin editing.

object

Catalog definition identifier.

string

nullable

Key

Stable catalog key.

string

nullable

DisplayName

Catalog display name.

string

nullable

Description

Optional free-form description.

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SecurityMode

integer format: int32

Allowed values: 0 1

CatalogAdministratorRoles

Roles allowed to read and administer the catalog tree at runtime.

Array<object>

nullable

One role allowed to administer root catalog folders at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

CatalogReaderRoles

Roles allowed to read the catalog at runtime.

Array<object>

nullable

One role allowed to read a catalog at runtime.

object

RoleId

Role identifier.

string

nullable

RoleName

Role display name.

string

nullable

TargetEntityDefinitionCount

Number of entity definitions admitted into the catalog.

integer format: int32

Targets

Entity definitions admitted into the catalog.

Array<object>

nullable

One entity definition admitted into a catalog definition.

object

Catalog target identifier.

string

nullable

CatalogDefinitionId

Catalog definition identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionName

Entity definition technical name.

string

nullable

EntityDefinitionDisplayNameSingular

Entity definition singular display name.

string

nullable

EntityDefinitionDisplayNamePlural

Entity definition plural display name.

string

nullable

UsageType

integer format: int32

Allowed values: 0 1 2

ListFields

Configured compact list projection fields.

Array<object>

nullable

One configured compact list projection field for a catalog target.

object

Catalog target list field identifier.

string

nullable

SourceKind

integer format: int32

Allowed values: 0 1

FieldKey

Provider or entity field key.

string

nullable

DisplayName

Default display name.

string

nullable

DisplayNameOverride

Optional target-specific display name.

string

nullable

ValueType

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

SortOrder

Display order.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

SortOrder

Display order in the catalog definition.

integer format: int32

RowVersion

Concurrency token.

string format: uuid

RowVersion

Concurrency token.

string format: uuid

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

{
  "Data": {
    "Kind": 0,
    "SecurityMode": 0,
    "Targets": [
      {
        "UsageType": 0,
        "ListFields": [
          {
            "SourceKind": 0,
            "ValueType": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Update one catalog definition.

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