CustomProperty

AnalyticsBusiness IntelligenceData VisualizationEnterpriseREST API

Properties

Name	Type	Description
id	string
createdDate	string
modifiedDate	string
modifiedByUserName	string
name	string	Custom property name
valueType	string	Value type for the custom property
choiceValues	array	Allowed values for this custom property
objectTypes	array	Entity types this custom property can be applied to (e.g., App, Stream, User)
description	string
privileges	array
schemaPath	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomProperty",
  "title": "CustomProperty",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedDate": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedByUserName": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Custom property name"
    },
    "valueType": {
      "type": "string",
      "description": "Value type for the custom property"
    },
    "choiceValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Allowed values for this custom property"
    },
    "objectTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Entity types this custom property can be applied to (e.g., App, Stream, User)"
    },
    "description": {
      "type": "string"
    },
    "privileges": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "schemaPath": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}