Skip to main content

LabTestUploadRequestBody

Upload/Update Pre-Created Lab Test request body.

Product list (items / styles / materials) is optional and type-specific: only the Product list matching the Lab Test Form's Product Type may be provided (items for Item, styles for Style, materials for Material). Omit the Product list entirely if no Product needs to be updated; if provided, send ALL Products for the test because the whole list is REPLACED.

oneOf
reportNumberstringrequired
originalReportNumberstringrequired
revisionNumberintegernullable
reportIssueDatedaterequired
Example: 2024-04-24
items object[]nullable

Optional Item list. Only applicable when the Lab Test Form's Product Type is Item. Omit this field entirely if no Product needs to be updated. If provided, send ALL Items for the test because the whole Item list is REPLACED.

  • Array [
  • itemIdstringrequired

    Possible values: <= 255 characters

    itemNamestringnullable

    Possible values: <= 255 characters

    itemDescriptionstringnullable

    Possible values: <= 255 characters

    styleIdstringrequired

    Possible values: <= 255 characters

    styleNamestringnullable

    Possible values: <= 255 characters

    colorstringnullable

    Possible values: <= 255 characters

    Default value:
    sizestringnullable

    Possible values: <= 255 characters

    originCountrystring[]nullable

    Possible values: Value must match regular expression ^[A-Z]{2}$

    sampleSizeintegernullable
    unitstringnullable

    Possible values: <= 255 characters

    Default value:
  • ]
  • testResultAttachments object[]required
  • Array [
  • fileIduuidrequired
    Example: f85774e7-cb3a-4bf3-ab8a-92e22bed41ac
    labelstringnullable
  • ]
  • testPackages object[]nullable
  • Array [
  • idstringrequired
    namestringrequired
    typestringnullable
  • ]
  • testProperties object[]required
  • Array [
  • idstringrequired
    namestringrequired
    testPackageIdstringnullable
    testCategoryIdstringnullable
    testSubcategoryIdstringnullable
    testMethodstringnullable
    resultstringnullable

    Possible values: [pass, fail, data, na]

    reviewResultstringnullable

    Possible values: <= 255 characters

    items object[]nullable
  • Array [
  • itemIdstringnullable
    testConditions object[]nullable
  • Array [
  • idstringnullable
    namestringnullable
    resultResultEnumnullable
    • pass - Pass
    • fail - Fail
    • data - Data
    • na - N/A

    Possible values: [pass, fail, data, na]

    samples object[]nullable
  • Array [
  • datastringnullable
    resultstringrequired

    Possible values: [pass, fail, data]

    sampleNumbersinteger[]required
  • ]
  • followUpAction objectnullable
    commentstringnullable
    attachments object[]nullable
  • Array [
  • fileIduuidrequired
    labelstringnullable
  • ]
  • failureCategoryIdstringnullable
    failureCategoryNamestringnullable
    failureIdstringnullable
    failureNamestringnullable
    failureSeveritystringnullable

    Possible values: [critical, major, minor]

  • ]
  • ]
  • ]
  • overallResult objectrequired
    resultstringrequired

    Possible values: [pass, fail, data]

    Example: pass
    reviewResultstringnullable
    questionnaire objectnullable
    forTestExecution object[]required
  • Array [
  • integrationKeystringrequired
    valuesstring[]required
  • ]
  • labAgency object
    localOrganizationIdstringnullable

    Possible values: <= 255 characters

    addressstringnullable
    citystringnullable

    Possible values: <= 255 characters

    countrystringnullable

    iso alpha-2 country code

    Possible values: <= 2 characters

    provincestringnullable

    Possible values: <= 255 characters

    postalstringnullable

    Possible values: <= 50 characters

    contacts object[]
  • Array [
  • namestringnullable

    Possible values: <= 255 characters

    emailemailnullable

    Possible values: <= 255 characters

    telephoneNumberstringnullable

    Possible values: <= 80 characters

    mobileNumberstringnullable

    Possible values: <= 80 characters

  • ]
  • LabTestUploadRequestBody
    {
    "reportNumber": "string",
    "originalReportNumber": "string",
    "revisionNumber": 0,
    "reportIssueDate": "2024-04-24",
    "items": [
    {
    "itemId": "string",
    "itemName": "string",
    "itemDescription": "string",
    "styleId": "string",
    "styleName": "string",
    "color": "",
    "size": "string",
    "originCountry": [
    "string"
    ],
    "sampleSize": 0,
    "unit": ""
    }
    ],
    "testResultAttachments": [
    {
    "fileId": "f85774e7-cb3a-4bf3-ab8a-92e22bed41ac",
    "label": "string"
    }
    ],
    "testPackages": [
    {
    "id": "string",
    "name": "string",
    "type": "string"
    }
    ],
    "testProperties": [
    {
    "id": "string",
    "name": "string",
    "testPackageId": "string",
    "testCategoryId": "string",
    "testSubcategoryId": "string",
    "testMethod": "string",
    "result": "pass",
    "reviewResult": "string",
    "items": [
    {
    "itemId": "string",
    "testConditions": [
    {
    "id": "string",
    "name": "string",
    "result": "pass",
    "samples": [
    {
    "data": "string",
    "result": "pass",
    "sampleNumbers": [
    0
    ]
    }
    ],
    "followUpAction": {
    "comment": "string",
    "attachments": [
    {
    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "label": "string"
    }
    ],
    "failureCategoryId": "string",
    "failureCategoryName": "string",
    "failureId": "string",
    "failureName": "string",
    "failureSeverity": "critical"
    }
    }
    ]
    }
    ]
    }
    ],
    "overallResult": {
    "result": "pass",
    "reviewResult": "string"
    },
    "questionnaire": {
    "forTestExecution": [
    {
    "integrationKey": "string",
    "values": [
    "string"
    ]
    }
    ]
    },
    "labAgency": {
    "localOrganizationId": "string",
    "address": "string",
    "city": "string",
    "country": "string",
    "province": "string",
    "postal": "string",
    "contacts": [
    {
    "name": "string",
    "email": "[email protected]",
    "telephoneNumber": "string",
    "mobileNumber": "string"
    }
    ]
    }
    }