validateAssets
post
/ccadmin/v1/asset/validate
Validate Assets. Validates catalog or inventory items.
Request
Supported Media Types
- application/json
Root Schema : validateAssets_request
Type:
Show Source
object
-
getValidationResult(optional):
string
The flag that indicates whether the validation result should be included in response.By default, the result won't be included.
-
token:
string
The token associated with a previous upload operation, for which the validation operation will take place.
Example:
{
"token":"QEnltim5M5VNaygUgjomyR0hzV4_10037"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : validateAssets_response
Type:
Show Source
object
-
errorCount(optional):
integer
Total number of uploaded assets that had errors during validation.
-
modifiedCount(optional):
integer
Total number of uploaded assets that will result in an update operation.
-
newCount(optional):
integer
Total number of uploaded assets that will result in an add operation.
-
total(optional):
integer
Total number of uploaded assets.
-
unchangedCount(optional):
integer
Total number of uploaded assets that will result in no change.
-
validationResults(optional):
array validationResults
Partial list of validation results.
-
warningCount(optional):
integer
Total number of uploaded assets that had warnings during validation.
Nested Schema : items
Type:
Show Source
object
-
isNew(optional):
boolean
true if the asset will be added.
-
modified(optional):
boolean
true if the asset will be updated.
-
validationResult(optional):
string
The status result of the validation operation.
-
valueDictionary(optional):
object valueDictionary
Additional Properties Allowed: additionalPropertiesMap of item property values that will be set on import. The key is the property name, and the value is the property value. The property value will either be a string or a key value pair in the case of a repository item reference.
Nested Schema : valueDictionary
Type:
object
Additional Properties Allowed
Show Source
Map of item property values that will be set on import. The key is the property name, and the value is the property value. The property value will either be a string or a key value pair in the case of a repository item reference.
Example Response (application/json)
{
"total":1,
"newCount":1,
"validationResults":[
{
"valueDictionary":{
"longDescription":"null",
"salePrice":"null",
"displayName":"The Good, the Bad, and the Ugly",
"orderLimit":"10",
"length":"100.0",
"weight":"10000.0",
"active":true,
"description":"A really great movie that you should not miss",
"type":"null",
"taxCode":"null",
"CountryOfOrigen":"US",
"arrivalDate":"null",
"width":"1000.0",
"shippingSurcharge":"15.00",
"brand":"Test2",
"listPrice":"14.99",
"height":"1.0"
},
"allAssetPropertyNames":[
"ID",
"displayName",
"type",
"description",
"brand",
"longDescription",
"active",
"listPrice",
"salePrice",
"shippingSurcharge",
"arrivalDate",
"height",
"length",
"width",
"weight",
"taxCode",
"orderLimit",
"images",
"altText",
"CountryOfOrigen"
],
"modified":false,
"isNew":true,
"type":"product",
"validateResult":"SUCCESS"
}
],
"modifiedCount":0,
"description":"Sample response of validate operation for catalog items",
"warningCount":0,
"unchangedCount":0,
"errorCount":0,
"token":"kWgU9foxZ3yfb1UCOAgeZgfresc_10038"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code