Jump to

• Request
• Response

validateAssets

post

/ccadmin/v1/asset/validate

Validate Assets. Validates catalog or inventory items.

Request

Supported Media Types

• application/json

Body ()

Root Schema : validateAssets_request

Type: object

Show Source

• 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.

{
    "properties":{
        "getValidationResult":{
            "description":"The flag that indicates whether the validation result should be included in response.By default, the result won't be included.",
            "type":"string"
        },
        "token":{
            "description":"The token associated with a previous upload operation, for which the validation operation will take place.",
            "type":"string"
        }
    },
    "required":[
        "token"
    ],
    "example":{
        "token":"QEnltim5M5VNaygUgjomyR0hzV4_10037"
    }
}

Example:

{
    "token":"QEnltim5M5VNaygUgjomyR0hzV4_10037"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : validateAssets_response

Type: object

Show Source

• 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.

{
    "properties":{
        "total":{
            "description":"Total number of uploaded assets.",
            "type":"integer"
        },
        "newCount":{
            "description":"Total number of uploaded assets that will result in an add operation.",
            "type":"integer"
        },
        "validationResults":{
            "description":"Partial list of validation results.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "valueDictionary":{
                        "description":"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.",
                        "additionalProperties":{
                            "type":"string"
                        },
                        "type":"object"
                    },
                    "validationResult":{
                        "description":"The status result of the validation operation.",
                        "type":"string"
                    },
                    "modified":{
                        "description":"true if the asset will be updated.",
                        "type":"boolean"
                    },
                    "isNew":{
                        "description":"true if the asset will be added.",
                        "type":"boolean"
                    }
                }
            }
        },
        "modifiedCount":{
            "description":"Total number of uploaded assets that will result in an update operation.",
            "type":"integer"
        },
        "warningCount":{
            "description":"Total number of uploaded assets that had warnings during validation.",
            "type":"integer"
        },
        "unchangedCount":{
            "description":"Total number of uploaded assets that will result in no change.",
            "type":"integer"
        },
        "errorCount":{
            "description":"Total number of uploaded assets that had errors during validation.",
            "type":"integer"
        }
    }
}

Nested Schema : validationResults

Type: array

Partial list of validation results.

Show Source

• Array of: object items

{
    "description":"Partial list of validation results.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "valueDictionary":{
                "description":"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.",
                "additionalProperties":{
                    "type":"string"
                },
                "type":"object"
            },
            "validationResult":{
                "description":"The status result of the validation operation.",
                "type":"string"
            },
            "modified":{
                "description":"true if the asset will be updated.",
                "type":"boolean"
            },
            "isNew":{
                "description":"true if the asset will be added.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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: additionalProperties

  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.

{
    "type":"object",
    "properties":{
        "valueDictionary":{
            "description":"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.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "validationResult":{
            "description":"The status result of the validation operation.",
            "type":"string"
        },
        "modified":{
            "description":"true if the asset will be updated.",
            "type":"boolean"
        },
        "isNew":{
            "description":"true if the asset will be added.",
            "type":"boolean"
        }
    }
}

Nested Schema : valueDictionary

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"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.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top