latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

form_schemas

Get a form schema

get/app/v1/form_schemas/{id}

Path parameters

idstring uuid required

Form Schema ID

Query parameters

versioninteger

Form Schema Version

Response

A successful operation

company_idstring uuid
created_atstring date-time
created_bystring uuid
descriptionstring
form_submission_editableboolean
form_category_idstring uuid
idstring uuid
namestring
status'active' | 'archived' | 'draft'
updated_atstring date-time
versioninteger

Example response

{
  "config": {
    "questions": {
      "questionId1": {
        "description": "Look at gauge",
        "subject_lookup_question_id": "lookupQuestionId",
        "source_lookup_question_id": "deviceQuestion",
        "measurement_time_question_id": "measurementTimeQuestion",
        "is_required": false,
        "measurement_type": "temperature",
        "measurement_unit": "degrees Celsius",
        "prompt": "Input measurement 1",
        "type": "measurement",
        "default_answer": 40,
        "minimum": 1,
        "maximum": 100
      },
      "questionId2": {
        "data_type": "string",
        "description": "Is gauge working?",
        "is_required": false,
        "prompt": "Input question 1",
        "type": "question",
        "min_length": 1,
        "max_length": 100
      },
      "questionId3": {
        "data_type": "string",
        "description": "Description of the problem",
        "is_required": false,
        "prompt": "Question 2",
        "type": "question",
        "is_long_string": true
      },
      "questionIdBoolean": {
        "data_type": "boolean",
        "description": "Input question Boolean",
        "is_required": false,
        "prompt": "Input question Boolean",
        "type": "question"
      },
      "facilityLookupQuestionId": {
        "data_type": "lookup",
        "description": "Facility",
        "is_required": false,
        "lookup_entity_type": "facility",
        "prompt": "Facility checked",
        "type": "question"
      },
      "lookupQuestionId": {
        "data_type": "lookup",
        "description": "Equipment that has the temperature sensor",
        "is_required": false,
        "lookup_entity_type": "equipment",
        "prompt": "Equipment checked",
        "parent_facility_question_id": "facilityLookupQuestionId",
        "filter": {
          "name": {
            "$like": "AB123"
          }
        },
        "type": "question",
        "conditions": {
          "$or": [
            {
              "questionId1": {
                "$gt": 5
              },
              "questionId2": 10
            },
            {
              "questionId3": 1
            }
          ]
        }
      },
      "deviceQuestion": {
        "data_type": "lookup",
        "description": "Device that monitors temperature",
        "is_required": false,
        "lookup_entity_type": "device",
        "prompt": "Gauge that was read",
        "type": "question",
        "conditions": {
          "questionIdBoolean": true
        }
      },
      "measurementTimeQuestion": {
        "data_type": "date-time",
        "description": "Time the temperature sensor was read",
        "is_required": false,
        "prompt": "Measurement Time",
        "type": "question",
        "default_answer": "$now",
        "before": "2024-01-01",
        "after": "$now"
      },
      "note": {
        "data_type": "string",
        "description": "note",
        "is_required": false,
        "prompt": "note",
        "type": "question",
        "default_answer": {
          "lookup_question_id": "facilityLookupQuestionId",
          "lookup_attribute": "area"
        }
      },
      "fileUploadQuestion": {
        "data_type": "file",
        "description": "File",
        "is_required": false,
        "prompt": "File",
        "type": "question"
      }
    },
    "sections": [
      {
        "questions": [
          "questionId1",
          "questionId2",
          "facilityLookupQuestionId",
          "lookupQuestionId",
          "deviceQuestion",
          "measurementTimeQuestion"
        ]
      }
    ]
  }
}