DataCollectorDto Data Type

Equivalent of EnableBusinessEntity in DTO

Implemented Interfaces
Serializable
Properties
name data type description
code string
description string
sqlQuery string String represents the SQL query to execute by the Data Selector SQL query format example : FROM Table WHERE CONDITION
aliases map of string Aliases represents fields and their aliases used in the SQL query Map : key represent the field value: field alias
parameters map of string Parameters used in the SQL query
customTableCode string Custom table code Existing custom table to be used by the data collector
customTable CustomEntityTemplateDto Custom table information used to create new custom entity for the data collector Custom table to use for data selector to store SQL query result
disabled boolean Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
id number The id.
auditableField array of AuditableFieldDto
updatedCode string The updated code.

Example

{
  "code" : "...",
  "description" : "...",
  "sqlQuery" : "...",
  "aliases" : {
    "property1" : "...",
    "property2" : "..."
  },
  "parameters" : {
    "property1" : "...",
    "property2" : "..."
  },
  "customTableCode" : "...",
  "customTable" : {
    "disabled" : true,
    "id" : 12345,
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "code" : "...",
    "name" : "...",
    "storeAsTable" : true,
    "description" : "...",
    "storeInES" : true,
    "field" : [ {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "languageDescriptions" : [ { }, { } ],
      "updatedCode" : "...",
      "fieldType" : "DOUBLE",
      "appliesTo" : "...",
      "defaultValue" : "...",
      "useInheritedAsDefaultValue" : true,
      "storageType" : "MATRIX",
      "valueRequired" : true,
      "uniqueConstraint" : true,
      "versionable" : true,
      "triggerEndPeriodEvent" : true,
      "calendar" : "...",
      "entityClazz" : "...",
      "listValues" : {
        "property1" : "...",
        "property2" : "..."
      },
      "allowEdit" : true,
      "hideOnNew" : true,
      "maxValue" : 12345,
      "minValue" : 12345,
      "regExp" : "...",
      "nbDecimal" : 12345,
      "roundingMode" : "HALF_EVEN",
      "guiPosition" : "...",
      "mapKeyType" : "STRING",
      "applicableOnEl" : "...",
      "matrixColumn" : [ { }, { } ],
      "fieldCode" : [ "...", "..." ],
      "indexType" : "INDEX",
      "tags" : "...",
      "displayFormat" : "...",
      "customTableCodeEL" : "...",
      "dataFilterEL" : "...",
      "fieldsEL" : "...",
      "versionFilterEL" : "..."
    }, {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "languageDescriptions" : [ { }, { } ],
      "updatedCode" : "...",
      "fieldType" : "CHECKBOX_LIST",
      "appliesTo" : "...",
      "defaultValue" : "...",
      "useInheritedAsDefaultValue" : true,
      "storageType" : "LIST",
      "valueRequired" : true,
      "uniqueConstraint" : true,
      "versionable" : true,
      "triggerEndPeriodEvent" : true,
      "calendar" : "...",
      "entityClazz" : "...",
      "listValues" : {
        "property1" : "...",
        "property2" : "..."
      },
      "allowEdit" : true,
      "hideOnNew" : true,
      "maxValue" : 12345,
      "minValue" : 12345,
      "regExp" : "...",
      "nbDecimal" : 12345,
      "roundingMode" : "UP",
      "guiPosition" : "...",
      "mapKeyType" : "DOUBLE",
      "applicableOnEl" : "...",
      "matrixColumn" : [ { }, { } ],
      "fieldCode" : [ "...", "..." ],
      "indexType" : "STORE_ONLY",
      "tags" : "...",
      "displayFormat" : "...",
      "customTableCodeEL" : "...",
      "dataFilterEL" : "...",
      "fieldsEL" : "...",
      "versionFilterEL" : "..."
    } ],
    "updatedCode" : "...",
    "action" : [ {
      "disabled" : true,
      "appliesTo" : "...",
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "applicableOnEl" : "...",
      "code" : "...",
      "label" : "...",
      "labelsTranslated" : [ { }, { } ],
      "description" : "...",
      "script" : { },
      "updatedCode" : "...",
      "guiPosition" : "..."
    }, {
      "disabled" : true,
      "appliesTo" : "...",
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "applicableOnEl" : "...",
      "code" : "...",
      "label" : "...",
      "labelsTranslated" : [ { }, { } ],
      "description" : "...",
      "script" : { },
      "updatedCode" : "...",
      "guiPosition" : "..."
    } ],
    "disableable" : true,
    "versioned" : true
  },
  "disabled" : true,
  "id" : 12345,
  "auditableField" : [ {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  }, {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  } ],
  "updatedCode" : "..."
}