Schema for Onform Submission Metadata

From SubmissionMetadata.schema.yaml (onform/SubmissionMetadata.schema)

---
$id: https://skeleton.botmd.io/onform/SubmissionMetadata.schema
$schema: http://json-schema.org/draft-07/schema#4

title: Submission Metadata
description: "`SubmissionV2.metadata` is used to store submission metadata such as processing status."

type: object
additionalProperties: false
required: [status, provider_saved_on]

properties:
  status:
    title: Status
    description: Status of the processing of the submission. It starts at `provider_saved`.

    enum: [provider_saved, application_success, application_failure]

  provider_saved_on:
    title: Provider Saved On
    description: DateTime the submission was saved into the database.
    type: string
    format: date-time

  application_success_on:
    title: Application Success On
    description: DateTime the application has successfully processed the submission.
    type: string
    format: date-time

  application_failure_on:
    title: Application Failure On
    description: DateTime the application has failed to process the submission.
    type: string
    format: date-time

  exception_traceback:
    title: Exception Traceback
    description: Exception traceback if an exception occurred during submission processing.
    type: string
#end properties

[Main Page] [Schema Documentation] [Examples]