v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Reports

Update a custom cdf on a report

put/datainsights/v1.1/reports/{report_id}/custom_cdfs/{custom_cdf_id}

Path parameters

report_idinteger required

Report id of the resource

custom_cdf_idinteger required

Custom cdf id of the resource

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

idinteger

Report custom cdf id

columnstring

Report custom cdf column

namestring required

Report custom cdf name

descriptionstring nullable

Report custom cdf description

kind'String' | 'Number' | 'Dynamic' required

Report custom cdf kind

created_atstring

Report custom cdf created at

updated_atstring

Report custom cdf updated at

format'number' | 'currency' | 'percentage' | 'null' nullable

Custom Cdf Numeric format (valid for Number and Dynamic only)

Example request

{
  "column": "full_address",
  "name": "Full address",
  "description": "CDF with the full address information",
  "kind": "String",
  "format": "currency"
}

Response

OK

idinteger

Report custom cdf id

columnstring

Report custom cdf column

namestring required

Report custom cdf name

descriptionstring nullable

Report custom cdf description

kind'String' | 'Number' | 'Dynamic' required

Report custom cdf kind

created_atstring

Report custom cdf created at

updated_atstring

Report custom cdf updated at

format'number' | 'currency' | 'percentage' | 'null' nullable

Custom Cdf Numeric format (valid for Number and Dynamic only)

Example response

{
  "column": "full_address",
  "name": "Full address",
  "description": "CDF with the full address information",
  "kind": "String",
  "format": "currency"
}