Load current parameter options after checking source grants.

POST

/api/workspace/data-sources/{catalogItemId}/options

curl --request POST \
  --url https://example.com/api/workspace/data-sources/example/options \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ParameterKey": "example", "ParameterValues": { "additionalProperty": "example" } }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

catalogItemId

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

Request to resolve options for a select-like data-source parameter.

object

ParameterKey

Data-source parameter key.

string

nullable

ParameterValues

Current parameter values that may influence dynamic options.

object

key

additional properties

Example^generated

{
  "ParameterKey": "example",
  "ParameterValues": {
    "additionalProperty": "example"
  }
}

Request to resolve options for a select-like data-source parameter.

object

ParameterKey

Data-source parameter key.

string

nullable

ParameterValues

Current parameter values that may influence dynamic options.

object

key

additional properties

Example^generated

{
  "ParameterKey": "example",
  "ParameterValues": {
    "additionalProperty": "example"
  }
}

Request to resolve options for a select-like data-source parameter.

object

ParameterKey

Data-source parameter key.

string

nullable

ParameterValues

Current parameter values that may influence dynamic options.

object

key

additional properties

Example^generated

{
  "ParameterKey": "example",
  "ParameterValues": {
    "additionalProperty": "example"
  }
}

Responses

200

OK

Media typeapplication/json

object

Data

Represents a flat or grouped select-like option set.

object

Options

Array<object>

nullable

Represents one select-like parameter option.

object

Value

string

nullable

Label

string

nullable

GroupKey

string

nullable

Disabled

boolean

Groups

Array<object>

nullable

Represents a group for select-like options.

object

Key

string

nullable

Label

string

nullable

Disabled

boolean

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

Media typeapplication/json

object

Data

Represents a flat or grouped select-like option set.

object

Options

Array<object>

nullable

Represents one select-like parameter option.

object

Value

string

nullable

Label

string

nullable

GroupKey

string

nullable

Disabled

boolean

Groups

Array<object>

nullable

Represents a group for select-like options.

object

Key

string

nullable

Label

string

nullable

Disabled

boolean

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

Media typeapplication/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"
}