Skip to main content

CQP

Full CQP aggregate returned by the integration API.

iduuidrequired
namestringrequired

Possible values: <= 255 characters

cqpTypeCQPTyperequired

Possible values: [safety, functional, regulation]

descriptionstringrequired

Empty string when not provided.

statusCQPStatusrequired

Possible values: [pending, reviewed]

sourceCQPSourcerequired

Creation provenance. POST creates records with api; PUT preserves the existing value and never changes how the CQP was originally created.

Possible values: [manual, api, csv_import, library]

cqcsstring[]required

Possible values: <= 255 characters

commentstringrequired

Empty string when not provided.

mitigations object[]required
  • Array [
    • iduuidrequired

    Regenerated when the aggregate is replaced with PUT.

    controlLayerTypeControlLayerType

    Possible values: [product_spec, material, production_process]

    productionStepProductionStep

    Possible values: [material_preparation, cutting, forming_molding, printing_dyeing, sewing, assembly, surface_finishing, washing, finishing, labeling, packing, other]

    specificationstring
    productionControlCheckstring
    qualityControlCheckstring
    createdAtdate-timerequired
    updatedAtdate-timerequired
  • ]
    • verifications object[]required
  • Array [
    • iduuidrequired

    Regenerated when the aggregate is replaced with PUT.

    stageTypeVerificationStage

    Possible values: [pre_production, during_production, post_production]

    methodTypeVerificationMethod

    Possible values: [certified_lab_test, process_verification_checklist, inspection]

    inspectionTypesstring[]

    Possible values: <= 50 characters

    acceptanceCriteriastring
    assignedToVerificationAssignedTo

    Possible values: [third_party, brand_retailer, supplier_factory]

    createdAtdate-timerequired
    updatedAtdate-timerequired
  • ]
    • attachments object[]required
  • Array [
    • iduuidrequired

    Regenerated when the aggregate is replaced with PUT.

    fileUrluri

    Possible values: <= 500 characters

    fileNamestring

    Possible values: <= 255 characters

    fileContentTypestring

    Possible values: <= 200 characters

    createdAtdate-timerequired
    updatedAtdate-timerequired
  • ]
    • createdAtdate-timerequired
    updatedAtdate-timerequired
    CQP
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "cqpType": "safety",
      "description": "string",
      "status": "pending",
      "source": "manual",
      "cqcs": [
        "string"
      ],
      "comment": "string",
      "mitigations": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "controlLayerType": "product_spec",
          "productionStep": "material_preparation",
          "specification": "string",
          "productionControlCheck": "string",
          "qualityControlCheck": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "verifications": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "stageType": "pre_production",
          "methodType": "certified_lab_test",
          "inspectionTypes": [
            "string"
          ],
          "acceptanceCriteria": "string",
          "assignedTo": "third_party",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "attachments": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fileUrl": "string",
          "fileName": "string",
          "fileContentType": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }