Skip to content
MoltaroMoltaroMoltaro Docs

Save name, description, categories and Use source grants at the expected version.

PUT
/api/workspace/admin/data-sources/catalog/{catalogItemId}
curl --request PUT \
  --url https://example.com/api/workspace/admin/data-sources/catalog/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "NameOverride": "example", "DescriptionOverride": "example", "UserIds": [ "example" ], "RoleIds": [ "example" ], "CategoryIds": [ "example" ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
catalogItemId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Body

Section titled “Request Body”

Replace one source’s workspace settings using its expected version.

object
NameOverride

Null uses developer text; otherwise a nonblank name of at most 256 characters.

string
nullable
DescriptionOverride

Null uses developer text; empty hides it; maximum 4000 characters.

string
nullable
UserIds

Users granted Use source.

Array<string>
nullable
RoleIds

Roles granted Use source.

Array<string>
nullable
CategoryIds

Assigned workspace categories.

Array<string>
nullable
RowVersion

Expected version; null only for an unconfigured source.

string format: uuid
nullable
Examplegenerated
{
  "NameOverride": "example",
  "DescriptionOverride": "example",
  "UserIds": [
    "example"
  ],
  "RoleIds": [
    "example"
  ],
  "CategoryIds": [
    "example"
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Workspace settings; a null version denotes a source not yet configured.

object
NameOverride
string
nullable
DescriptionOverride
string
nullable
UserIds
Array<string>
nullable
RoleIds
Array<string>
nullable
Categories
Array<object>
nullable

A workspace-owned source classification.

object
Id
string
nullable
Name
string
nullable
DisplayOrder
integer format: int32
RowVersion
string format: uuid
RowVersion
string format: uuid
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

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Workspace settings; a null version denotes a source not yet configured.

object
NameOverride
string
nullable
DescriptionOverride
string
nullable
UserIds
Array<string>
nullable
RoleIds
Array<string>
nullable
Categories
Array<object>
nullable

A workspace-owned source classification.

object
Id
string
nullable
Name
string
nullable
DisplayOrder
integer format: int32
RowVersion
string format: uuid
RowVersion
string format: uuid
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

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
Data

Workspace settings; a null version denotes a source not yet configured.

object
NameOverride
string
nullable
DescriptionOverride
string
nullable
UserIds
Array<string>
nullable
RoleIds
Array<string>
nullable
Categories
Array<object>
nullable

A workspace-owned source classification.

object
Id
string
nullable
Name
string
nullable
DisplayOrder
integer format: int32
RowVersion
string format: uuid
RowVersion
string format: uuid
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
    }
  ]
}