Skip to main content

Run a MTP file validation

POST 

/v2/MtpValidator/validate

This route triggers the validation of a MTP file, returning a JSON report.

Request

Body

    mtpUpload binary

    MTP file to be validated

Responses

Answer when validation succeeded or session was successfully created

Schema

    reportID stringnullablerequired
    validatorVersion stringnullablerequired
    requestTime date-timerequired
    finishedTime date-timerequired
    validationType ValidationType (string)required

    Possible values: [OPC, AML]

    fileInformation

    object

    required

    fileName stringnullablerequired
    fileSize int64required
    sha256 stringnullablerequired
    md5 stringnullablerequired

    packageContents

    object[]

    nullable

  • Array [

  • fileName stringnullablerequired
    fileSize int64required
  • ]

  • amlInformation

    object

    required

    amlFileName stringnullablerequired
    caexVersion stringnullablerequired

    ruleResults

    object

    required

    criticalError boolean

    statistic

    object

    violatedRuleCount int32
    totalViolationCount int32
    recommendationCount int32
    informationCount int32
    warningCount int32
    errorCount int32
    criticalCount int32

    violatedRules

    object

    nullable

    property name*

    RuleDto

    nullable

    id stringnullablerequired
    name stringnullablerequired
    description stringnullablerequired

    references

    object

    required

    part stringnullablerequired
    sections string[]nullable
    modelingRules string[]nullable
    figures string[]nullable
    tables string[]nullable

    detectedViolations

    object

    nullable

    Semodia

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part1Aml

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part1Opc

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part1

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part2

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part3

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part4

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part5

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part51

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

  • Part6

    object[]

  • Array [

  • name stringnullablerequired
    message stringnullablerequired

    relatedObject

    object

    validatorID stringnullable
    name stringnullable
    id stringnullable
    type stringnullable
    libReference stringnullable
    severity ViolationSeverity (string)

    Possible values: [Information, Recommendation, Warning, Error, Critical]

    ruleID stringnullablerequired
    template stringnullablerequired
    templateArguments string[]nullablerequired
  • ]

Loading...