TCN API

UpdateOutputConfiguration

POST

https://api.cbf.tcn.com/api/v1alpha1/insights/insights/updateoutputconfiguration

Insights

UpdateOutputConfiguration updates an output configuration

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for updating an existing output configuration

update_mask

string

update_mask

optional

Field mask to update specified fields

output_configuration

optional

Updated output configuration

Any of

allOf {2}

One of

OutputConfiguration

Output configuration provides formatting options in post processing

output_configuration_type

enum<string>

output_configuration_type

optional

Type of the output configuration

Allowed values:

OUTPUT_CONFIGURATION_TYPE_UNSPECIFIEDOUTPUT_CONFIGURATION_TYPE_TABLEOUTPUT_CONFIGURATION_TYPE_MULTI_SERIESOUTPUT_CONFIGURATION_TYPE_PIE_CHARTOUTPUT_CONFIGURATION_TYPE_FIXED_WIDTHOUTPUT_CONFIGURATION_TYPE_TIMELINEOUTPUT_CONFIGURATION_TYPE_TEXT_VALUES

table_visualization

object (TableVisualization)

table_visualization

optional

Table visualization data for the output configuration

card_visualization

object (CardVisualization)

card_visualization

optional

Card visualization data for the output configuration

create_time

string <date-time>

create_time

optional

create time of output configuration

update_time

string <date-time>

update_time

optional

update time of output configuration

resource_id

string

resource_id

optional

Unique identifier for the output configuration

output_configuration_title

string

output_configuration_title

optional

Title of the output configuration

insight_resource_id

string

insight_resource_id

optional

Insight resource ID associated with the output configuration

is_default

boolean

is_default

optional

is_default flag for the output configuration

blob

string

blob

optional

Blob data for the output configuration

Example

{
  "update_mask": "string",
  "output_configuration": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/insights/insights/updateoutputconfiguration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "update_mask": "string",
    "output_configuration": {}
}'

Responses

🟢200OK

application/json

Success

Body

Response for updating an existing output configuration

output_configuration

optional

Updated output configuration

Any of

allOf {2}

One of

OutputConfiguration

Output configuration provides formatting options in post processing

output_configuration_type

enum<string>

output_configuration_type

optional

Type of the output configuration

Allowed values:

table_visualization

object (TableVisualization)

table_visualization

optional

Table visualization data for the output configuration

card_visualization

object (CardVisualization)

card_visualization

optional

Card visualization data for the output configuration

create_time

string <date-time>

create_time

optional

create time of output configuration

update_time

string <date-time>

update_time

optional

update time of output configuration

resource_id

string

resource_id

optional

Unique identifier for the output configuration

output_configuration_title

string

output_configuration_title

optional

Title of the output configuration

insight_resource_id

string

insight_resource_id

optional

Insight resource ID associated with the output configuration

is_default

boolean

is_default

optional

is_default flag for the output configuration

blob

string

blob

optional

Blob data for the output configuration

Example

{
  "output_configuration": {}
}

🔴500Server Error

Modified at 2025-04-18 19:29:54

ListOutputConfigurations

DeleteOutputConfiguration