AttributeDTO Data Type

The Class ServiceDto.

Subtypes
GetAttributeDtoResponse
Implemented Interfaces
Serializable
Properties
name data type constraints description
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
id number   The id.
auditableField array of AuditableFieldDto  
code string required The code
description string   The description
updatedCode string   The updated code.
attributeType AttributeTypeEnum required Corresponding to minimum one shot charge template code.
allowedValues array of string   Corresponding to predefined allowed values
priority number   The lower number, the higher the priority is
selectable boolean  
ruled boolean  
chargeTemplateCodes array of string  
commercialRuleCodes array of string  
mediaCodes array of string   The media codes.
tags array of string   The tags
assignedAttributeCodes array of string  
unitNbDecimal number  
customFields CustomFieldsDto  
groupedAttributes array of GroupedAttributeDto  

Example

{
  "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" : "...",
  "description" : "...",
  "updatedCode" : "...",
  "attributeType" : "NUMERIC",
  "allowedValues" : [ "...", "..." ],
  "priority" : 12345,
  "selectable" : true,
  "ruled" : true,
  "chargeTemplateCodes" : [ "...", "..." ],
  "commercialRuleCodes" : [ "...", "..." ],
  "mediaCodes" : [ "...", "..." ],
  "tags" : [ "...", "..." ],
  "assignedAttributeCodes" : [ "...", "..." ],
  "unitNbDecimal" : 12345,
  "customFields" : {
    "customField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "DATE",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "CHILD_ENTITY",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ],
    "inheritedCustomField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "URL",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "LONG",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ]
  },
  "groupedAttributes" : [ {
    "code" : "...",
    "description" : "...",
    "attributes" : [ {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "updatedCode" : "...",
      "attributeType" : "EXPRESSION_LANGUAGE",
      "allowedValues" : [ "...", "..." ],
      "priority" : 12345,
      "selectable" : true,
      "ruled" : true,
      "chargeTemplateCodes" : [ "...", "..." ],
      "commercialRuleCodes" : [ "...", "..." ],
      "mediaCodes" : [ "...", "..." ],
      "tags" : [ "...", "..." ],
      "assignedAttributeCodes" : [ "...", "..." ],
      "unitNbDecimal" : 12345,
      "customFields" : { },
      "groupedAttributes" : [ { }, { } ]
    }, {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "updatedCode" : "...",
      "attributeType" : "DATE",
      "allowedValues" : [ "...", "..." ],
      "priority" : 12345,
      "selectable" : true,
      "ruled" : true,
      "chargeTemplateCodes" : [ "...", "..." ],
      "commercialRuleCodes" : [ "...", "..." ],
      "mediaCodes" : [ "...", "..." ],
      "tags" : [ "...", "..." ],
      "assignedAttributeCodes" : [ "...", "..." ],
      "unitNbDecimal" : 12345,
      "customFields" : { },
      "groupedAttributes" : [ { }, { } ]
    } ],
    "display" : true,
    "mandatory" : true,
    "commercialRuleCodes" : [ "...", "..." ],
    "selectable" : true,
    "ruled" : true,
    "id" : 12345,
    "disabled" : true,
    "attributeCodes" : [ "...", "..." ],
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "sequence" : 12345
  }, {
    "code" : "...",
    "description" : "...",
    "attributes" : [ {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "updatedCode" : "...",
      "attributeType" : "BOOLEAN",
      "allowedValues" : [ "...", "..." ],
      "priority" : 12345,
      "selectable" : true,
      "ruled" : true,
      "chargeTemplateCodes" : [ "...", "..." ],
      "commercialRuleCodes" : [ "...", "..." ],
      "mediaCodes" : [ "...", "..." ],
      "tags" : [ "...", "..." ],
      "assignedAttributeCodes" : [ "...", "..." ],
      "unitNbDecimal" : 12345,
      "customFields" : { },
      "groupedAttributes" : [ { }, { } ]
    }, {
      "disabled" : true,
      "id" : 12345,
      "auditableField" : [ { }, { } ],
      "code" : "...",
      "description" : "...",
      "updatedCode" : "...",
      "attributeType" : "INTEGER",
      "allowedValues" : [ "...", "..." ],
      "priority" : 12345,
      "selectable" : true,
      "ruled" : true,
      "chargeTemplateCodes" : [ "...", "..." ],
      "commercialRuleCodes" : [ "...", "..." ],
      "mediaCodes" : [ "...", "..." ],
      "tags" : [ "...", "..." ],
      "assignedAttributeCodes" : [ "...", "..." ],
      "unitNbDecimal" : 12345,
      "customFields" : { },
      "groupedAttributes" : [ { }, { } ]
    } ],
    "display" : true,
    "mandatory" : true,
    "commercialRuleCodes" : [ "...", "..." ],
    "selectable" : true,
    "ruled" : true,
    "id" : 12345,
    "disabled" : true,
    "attributeCodes" : [ "...", "..." ],
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "sequence" : 12345
  } ]
}