Skip to main content

FabricInspectionMaterial

colorstringrequired

Color of the material.

Example: Blue
compositionstringrequired

Composition of the material.

Example: 100% Cotton
cuttableWidthStandardnumbernullable

Standard cuttable width of the material.

Example: 150
gsmStandardnumbernullable

Standard grams per square meter of the material.

Example: 180
materialIdstringrequired

Id of an active material shared with the receiver.

Example: MAT-001
rollLengthStandardnumbernullable

Standard roll length of the material. When omitted the actual length of the first roll is used.

Example: 100
rolls object[]required

Inspected rolls. Roll ids must be unique within the material.

Possible values: >= 1

  • Array [
  • answers object[]

    Answers to the workflow questions of the fabric inspection section.

  • Array [
  • answerstring

    Answer to the question. Defaults to an empty string.

    Example: Good
    questionstringrequired

    Workflow question of the fabric inspection section. Use the CSV column-header form so that the answer is validated against the question type, for example "Additional notes (Freetext)", "Quality grade (single: A | B | C)", "Factory access granted? (Yes | No | N/A)", "Sample check (Pass | Fail)", "Inspection date (yyyy-MM-dd)" or "Defect types found (multi: Hole | Stain | Tear)". An answer whose question does not carry a recognised type suffix is stored but not validated.

    Example: Additional notes (Freetext)
  • ]
  • bowingintegernullable

    Measured bowing percentage of the roll.

    Example: 1
    cuttableWidthActualnumbernullable

    Measured cuttable width of the roll.

    Example: 149
    defects object[]

    Defects found on the roll.

  • Array [
  • defectstringrequired

    Defect id belonging to a defect category of the workflow.

    Example: 1.1
    defectCommentstring

    Free-text note about the defect. Defaults to an empty string.

    Example: Hole near selvedge
    defectiveMeterintegerrequired

    Defective length of the roll. Combined with defect it must be unique within the roll.

    Possible values: >= 0

    Example: 12
    occurrenceDefectinteger

    Number of times the defect occurs. Defaults to 1.

    Possible values: >= 1

    Example: 3
  • ]
  • gsmActualnumbernullable

    Measured grams per square meter of the roll.

    Example: 182
    lotIdstringrequired

    Lot identifier of the roll.

    Example: LOT-001
    rollIdstringrequired

    Roll identifier, unique within the material.

    Example: ROLL-001
    rollLengthActualnumberrequired

    Measured length of the roll.

    Example: 100.5
    skewingintegernullable

    Measured skewing percentage of the roll.

    Example: 2
    specialAttentionPointstring

    Free-text remark about the roll. Defaults to an empty string.

    Example: Edge damage
  • ]
  • totalQuantityintegernullable

    Total quantity of the material. Required to determine the sample size, so omitting it is rejected with the MISSING_REQUIRED_FIELD error code.

    Example: 100
    FabricInspectionMaterial
    {
    "color": "Blue",
    "composition": "100% Cotton",
    "cuttableWidthStandard": 150,
    "gsmStandard": 180,
    "materialId": "MAT-001",
    "rollLengthStandard": 100,
    "rolls": [
    {
    "answers": [
    {
    "answer": "Good",
    "question": "Additional notes (Freetext)"
    }
    ],
    "bowing": 1,
    "cuttableWidthActual": 149,
    "defects": [
    {
    "defect": "1.1",
    "defectComment": "Hole near selvedge",
    "defectiveMeter": 12,
    "occurrenceDefect": 3
    }
    ],
    "gsmActual": 182,
    "lotId": "LOT-001",
    "rollId": "ROLL-001",
    "rollLengthActual": 100.5,
    "skewing": 2,
    "specialAttentionPoint": "Edge damage"
    }
    ],
    "totalQuantity": 100
    }