Submit Form - Tracecat Docs

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "submitted_at": "2023-11-07T05:31:56Z",
  "reference": "<string>",
  "success_message": "<string>"
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

POST

/

workspaces

/

{workspace_id}

/

forms

/

{form_id}

/

submissions

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "submitted_at": "2023-11-07T05:31:56Z",
  "reference": "<string>",
  "success_message": "<string>"
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "detail": {
    "code": "not_found",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "required",
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "severity": "error",
        "code": "unknown_field",
        "message": "<string>",
        "loc": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

fastapiusersauth

string

cookie

required

Path Parameters

form_id

string<uuid>

required

workspace_id

string<uuid>

required

Body

application/json

values

Values · object

Answers keyed by field name.

definition_version

integer | null

The definition_version of the form the requester filled in. If set and stale, the submission is rejected with form_changed.

config_version

string | null

The config_version of the form the requester filled in. If set and stale, the submission is rejected with form_changed.

Response

Successful Response

What a requester gets back. Carries no run fields.

id

string<uuid>

required

submitted_at

string<date-time>

required

reference

string

required

read-only

Short code a requester can quote for a submission.

success_message

string | null