A base class for all API DTO classes
| name | data type | constraints | description |
|---|---|---|---|
| shortDescription | string | required | The shortDescription. |
| attributes | array of AttributeDTO | ||
| array of TagDto | |||
| productCode | string | required | The product code. |
| groupedAttributes | array of GroupedAttributeDto | ||
| currentVersion | number | required | |
| status | VersionStatusEnum | The status. | |
| statusDate | number | The statusDate. | |
| longDescription | string | The longDescription | |
| validity | DatePeriod | The validity Date | |
| productAttributes | array of ProductVersionAttributeDTO | The attributeCodes. | |
| groupedAttributeCodes | array of string | ||
| tagCodes | array of string | The services template. | |
| actionStatus | ActionStatus | The status response of the web service response. |
Example
{
"shortDescription" : "...",
"attributes" : [ {
"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" : "TEXT",
"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" : "LIST_MULTIPLE_TEXT",
"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
} ]
} ],
"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" : "..."
} ],
"productCode" : "...",
"groupedAttributes" : [ {
"code" : "...",
"description" : "...",
"attributes" : [ {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"attributeType" : "COUNT",
"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" : "CALENDAR",
"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" : "NUMERIC",
"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" : "EXPRESSION_LANGUAGE",
"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
} ],
"currentVersion" : 12345,
"status" : "PUBLISHED",
"statusDate" : 12345,
"longDescription" : "...",
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"productAttributes" : [ {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "REGEX",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"display" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
}, {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "EL",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"display" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
} ],
"groupedAttributeCodes" : [ "...", "..." ],
"tagCodes" : [ "...", "..." ],
"actionStatus" : {
"status" : "FAIL",
"errorCode" : { },
"message" : "...",
"entityId" : 12345,
"entityCode" : "...",
"nrAffected" : 12345,
"json" : "..."
}
}