v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Stock reports

Create a custom cdf for a stock report

A custom cdf gives the user the ability to create a new cdf based on existing cdf.
Column is generated over the name, only with alphanumerical values and lower case. Special characters are replaced with underscore(_)

Note:

A custom cdf should have a validate formula.

post/datainsights/v1.1/stock_reports/{stock_report_id}/custom_cdfs

Path parameters

stock_report_idinteger required

Stock report 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

Created