The Class ServiceDto.
| name | data type | constraints | description |
|---|---|---|---|
| chargeTemplates | array of ChargeTemplateDto | ||
| commercialRules | array of CommercialRuleHeaderDTO | ||
| array of TagDto | |||
| disabled | boolean | Is entity disabled. Value is ignored in Update action - use enable/disable API instead. | |
| assignedAttributes | array of AttributeDTO | ||
| medias | array of MediaDto | ||
| id | number | The id. | |
| groupedAttributes | array of GroupedAttributeDto | ||
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| actionStatus | ActionStatus | The status response of the web service response. | |
| 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. | |
| array of string | The tags | ||
| assignedAttributeCodes | array of string | ||
| unitNbDecimal | number | ||
| customFields | CustomFieldsDto |
Example
{
"chargeTemplates" : [ {
"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" : "...",
"invoiceSubCategory" : "...",
"updatedCode" : "...",
"amountEditable" : true,
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"inputUnitOfMeasureCode" : "...",
"ratingUnitOfMeasureCode" : "...",
"inputUnitEL" : "...",
"outputUnitEL" : "...",
"unitNbDecimal" : 12345,
"roundingModeDtoEnum" : "UP",
"revenueRecognitionRuleCode" : "...",
"filterExpression" : "...",
"taxClassCode" : "...",
"taxClassEl" : "...",
"ratingScriptCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"triggeredEdrs" : {
"triggeredEdr" : [ { }, { } ]
},
"dropZeroWo" : true,
"sortIndexEl" : "...",
"status" : "ARCHIVED",
"linkedAttributes" : [ "...", "..." ]
}, {
"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" : "...",
"invoiceSubCategory" : "...",
"updatedCode" : "...",
"amountEditable" : true,
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"inputUnitOfMeasureCode" : "...",
"ratingUnitOfMeasureCode" : "...",
"inputUnitEL" : "...",
"outputUnitEL" : "...",
"unitNbDecimal" : 12345,
"roundingModeDtoEnum" : "HALF_EVEN",
"revenueRecognitionRuleCode" : "...",
"filterExpression" : "...",
"taxClassCode" : "...",
"taxClassEl" : "...",
"ratingScriptCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"triggeredEdrs" : {
"triggeredEdr" : [ { }, { } ]
},
"dropZeroWo" : true,
"sortIndexEl" : "...",
"status" : "DRAFT",
"linkedAttributes" : [ "...", "..." ]
} ],
"commercialRules" : [ {
"ruleType" : "PRE_REQUISITE",
"ruleEl" : "...",
"offerCode" : "...",
"productCode" : "...",
"productVersion" : 12345,
"attributeCode" : "...",
"scope" : "QUOTE",
"tagCode" : "...",
"groupedAttributeCode" : "...",
"targetAttributeValue" : "...",
"isTarget" : 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" : "..."
} ],
"commercialRuleItems" : [ {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
}, {
"operator" : "OR",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"ruleType" : "INCOMPATIBILITY",
"ruleEl" : "...",
"offerCode" : "...",
"productCode" : "...",
"productVersion" : 12345,
"attributeCode" : "...",
"scope" : "QUOTE",
"tagCode" : "...",
"groupedAttributeCode" : "...",
"targetAttributeValue" : "...",
"isTarget" : 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" : "..."
} ],
"commercialRuleItems" : [ {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
}, {
"operator" : "OR",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"tags" : [ {
"sellerCode" : "...",
"name" : "...",
"tagTypeCode" : "...",
"parentTagCode" : "...",
"filterEl" : "...",
"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" : "..."
}, {
"sellerCode" : "...",
"name" : "...",
"tagTypeCode" : "...",
"parentTagCode" : "...",
"filterEl" : "...",
"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" : "..."
} ],
"disabled" : true,
"assignedAttributes" : [ {
"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" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"groupedAttributes" : [ {
"code" : "...",
"description" : "...",
"attributes" : [ { }, { } ],
"display" : true,
"mandatory" : true,
"commercialRuleCodes" : [ "...", "..." ],
"selectable" : true,
"ruled" : true,
"id" : 12345,
"disabled" : true,
"attributeCodes" : [ "...", "..." ],
"customFields" : { },
"sequence" : 12345
}, {
"code" : "...",
"description" : "...",
"attributes" : [ { }, { } ],
"display" : true,
"mandatory" : true,
"commercialRuleCodes" : [ "...", "..." ],
"selectable" : true,
"ruled" : true,
"id" : 12345,
"disabled" : true,
"attributeCodes" : [ "...", "..." ],
"customFields" : { },
"sequence" : 12345
} ]
}, {
"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" : "INFO",
"allowedValues" : [ "...", "..." ],
"priority" : 12345,
"selectable" : true,
"ruled" : true,
"chargeTemplateCodes" : [ "...", "..." ],
"commercialRuleCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"tags" : [ "...", "..." ],
"assignedAttributeCodes" : [ "...", "..." ],
"unitNbDecimal" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"groupedAttributes" : [ {
"code" : "...",
"description" : "...",
"attributes" : [ { }, { } ],
"display" : true,
"mandatory" : true,
"commercialRuleCodes" : [ "...", "..." ],
"selectable" : true,
"ruled" : true,
"id" : 12345,
"disabled" : true,
"attributeCodes" : [ "...", "..." ],
"customFields" : { },
"sequence" : 12345
}, {
"code" : "...",
"description" : "...",
"attributes" : [ { }, { } ],
"display" : true,
"mandatory" : true,
"commercialRuleCodes" : [ "...", "..." ],
"selectable" : true,
"ruled" : true,
"id" : 12345,
"disabled" : true,
"attributeCodes" : [ "...", "..." ],
"customFields" : { },
"sequence" : 12345
} ]
} ],
"medias" : [ {
"code" : "...",
"description" : "...",
"mediaName" : "...",
"label" : "...",
"main" : true,
"mediaType" : "VIDEO",
"mediaPath" : "...",
"id" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"code" : "...",
"description" : "...",
"mediaName" : "...",
"label" : "...",
"main" : true,
"mediaType" : "VIDEO",
"mediaPath" : "...",
"id" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"id" : 12345,
"groupedAttributes" : [ {
"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" : "TEXT",
"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" : "DATE",
"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" : "NUMERIC",
"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
} ],
"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" : "...",
"actionStatus" : {
"status" : "FAIL",
"errorCode" : { },
"message" : "...",
"entityId" : 12345,
"entityCode" : "...",
"nrAffected" : 12345,
"json" : "..."
},
"description" : "...",
"updatedCode" : "...",
"attributeType" : "TEXT",
"allowedValues" : [ "...", "..." ],
"priority" : 12345,
"selectable" : true,
"ruled" : true,
"chargeTemplateCodes" : [ "...", "..." ],
"commercialRuleCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"assignedAttributeCodes" : [ "...", "..." ],
"unitNbDecimal" : 12345,
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "LIST",
"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_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "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" : "..."
}, {
"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" : "..."
} ]
}
}