GET Forms?formId={formId}
Retrieves a form by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information | 
|---|---|---|---|
| formId | Id of the form | globally unique identifier | Required | 
Body Parameters
None.
Response Information
Resource Description
On success, the form.
| Name | Description | Type | Additional information | 
|---|---|---|---|
| Data | Form | None. | |
| Total | integer | None. | |
| Message | string | None. | 
Response Formats
application/json, text/json
            Sample:
{
  "Data": {
    "FormId": "dcdba43b-d6ff-4d06-9462-5ad002f2bc5b",
    "Asset": {
      "AssetId": "1d68b300-abf9-4d19-8b71-d7de01c333a2",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "816f2764-9351-4747-973d-1d07f7122a57",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayColor": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "974fda0d-c4d2-426e-a4ff-36b263f59304",
        "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "AssetGroup": {
        "AssetGroupId": "844927e8-f642-4bd8-aa24-ecf2ead5d672",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
        "MeasurementValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "42bc80d7-8620-4804-a1b1-5e7e22d7d203",
        "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "FormValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
      "MeasurementValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "e5a5f331-390d-4390-8dff-1c3ac4668ecc",
      "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "FormType": {
      "FormTypeId": "54dcbd8d-92aa-4dc4-98cc-6f60598c4905",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AssetType": {
        "AssetTypeId": "816f2764-9351-4747-973d-1d07f7122a57",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayColor": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "974fda0d-c4d2-426e-a4ff-36b263f59304",
        "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "FrequencyNeeded": 1,
      "ValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
      "Active": true,
      "Fields": [
        {
          "FormTypeFieldId": "50d4102c-aeab-472d-92da-ddd286c26c1d",
          "Section": {
            "FormTypeSectionId": "83540df9-202f-442f-82c3-c8e221eb11f4",
            "Name": "sample string 1",
            "Label": "sample string 2",
            "DisplayOrder": 1,
            "IsRepeatable": true,
            "VisibleExpression": "sample string 4",
            "SourceSystemId": "sample string 5"
          },
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "bcc70a70-465d-4846-a87e-45e26eb046bb",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "e94b81d1-4158-4adb-8bff-eb0da0c4044e",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "30e62fd8-92d4-4c02-af89-22c9d7613f57",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            }
          ],
          "ValueExpression": "sample string 5",
          "RequiredExpression": "sample string 6",
          "IsAttachment": true,
          "DefaultValueExpression": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "IsRepeatable": true,
          "VisibleExpression": "sample string 12",
          "SourceSystemId": "sample string 13"
        },
        {
          "FormTypeFieldId": "50d4102c-aeab-472d-92da-ddd286c26c1d",
          "Section": {
            "FormTypeSectionId": "83540df9-202f-442f-82c3-c8e221eb11f4",
            "Name": "sample string 1",
            "Label": "sample string 2",
            "DisplayOrder": 1,
            "IsRepeatable": true,
            "VisibleExpression": "sample string 4",
            "SourceSystemId": "sample string 5"
          },
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "bcc70a70-465d-4846-a87e-45e26eb046bb",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "e94b81d1-4158-4adb-8bff-eb0da0c4044e",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "30e62fd8-92d4-4c02-af89-22c9d7613f57",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            }
          ],
          "ValueExpression": "sample string 5",
          "RequiredExpression": "sample string 6",
          "IsAttachment": true,
          "DefaultValueExpression": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "IsRepeatable": true,
          "VisibleExpression": "sample string 12",
          "SourceSystemId": "sample string 13"
        }
      ],
      "SourceSystemId": "sample string 4",
      "CompanyId": "c41e9e3f-b9a2-461b-8896-0f68dd494304",
      "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
      "LastModifiedUser": "sample string 7"
    },
    "EffectiveDate": "2025-10-31T00:35:27.5429729-07:00",
    "Location": "sample string 1",
    "TaskId": "b9ab3eac-2e4a-4f6b-920e-12ea0c11a1a5",
    "Values": [
      {
        "FormFieldValueId": "1c0d3db4-d078-437a-9e8d-12738e6b3448",
        "FormId": "d7ddb1e3-73f7-4f8e-a9ac-6763f4db5a22",
        "FormTypeField": {
          "FormTypeFieldId": "50d4102c-aeab-472d-92da-ddd286c26c1d",
          "FormType": {
            "FormTypeId": "54dcbd8d-92aa-4dc4-98cc-6f60598c4905",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "AssetType": {
              "AssetTypeId": "816f2764-9351-4747-973d-1d07f7122a57",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "DisplayColor": "sample string 3",
              "SourceSystemId": "sample string 4",
              "CompanyId": "974fda0d-c4d2-426e-a4ff-36b263f59304",
              "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
              "CreateUser": "sample string 6",
              "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
              "LastModifiedUser": "sample string 7"
            },
            "FrequencyNeeded": 1,
            "ValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
            "Active": true,
            "Fields": [],
            "SourceSystemId": "sample string 4",
            "CompanyId": "c41e9e3f-b9a2-461b-8896-0f68dd494304",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 6",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 7"
          },
          "Section": {
            "FormTypeSectionId": "83540df9-202f-442f-82c3-c8e221eb11f4",
            "Name": "sample string 1",
            "Label": "sample string 2",
            "DisplayOrder": 1,
            "IsRepeatable": true,
            "VisibleExpression": "sample string 4",
            "SourceSystemId": "sample string 5"
          },
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "bcc70a70-465d-4846-a87e-45e26eb046bb",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "e94b81d1-4158-4adb-8bff-eb0da0c4044e",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "30e62fd8-92d4-4c02-af89-22c9d7613f57",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            }
          ],
          "ValueExpression": "sample string 5",
          "RequiredExpression": "sample string 6",
          "IsAttachment": true,
          "DefaultValueExpression": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "IsRepeatable": true,
          "VisibleExpression": "sample string 12",
          "SourceSystemId": "sample string 13"
        },
        "SectionIndex": 1,
        "FieldIndex": 1,
        "FileName": "sample string 1",
        "FileType": "sample string 2",
        "FileSize": 1,
        "FileContent": "QEA=",
        "ValueText": "sample string 3",
        "IsValid": true,
        "IsValidMessage": "sample string 5",
        "SourceSystemId": "sample string 6"
      },
      {
        "FormFieldValueId": "1c0d3db4-d078-437a-9e8d-12738e6b3448",
        "FormId": "d7ddb1e3-73f7-4f8e-a9ac-6763f4db5a22",
        "FormTypeField": {
          "FormTypeFieldId": "50d4102c-aeab-472d-92da-ddd286c26c1d",
          "FormType": {
            "FormTypeId": "54dcbd8d-92aa-4dc4-98cc-6f60598c4905",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "AssetType": {
              "AssetTypeId": "816f2764-9351-4747-973d-1d07f7122a57",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "DisplayColor": "sample string 3",
              "SourceSystemId": "sample string 4",
              "CompanyId": "974fda0d-c4d2-426e-a4ff-36b263f59304",
              "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
              "CreateUser": "sample string 6",
              "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
              "LastModifiedUser": "sample string 7"
            },
            "FrequencyNeeded": 1,
            "ValueNeededDate": "2025-10-31T00:35:27.5429729-07:00",
            "Active": true,
            "Fields": [],
            "SourceSystemId": "sample string 4",
            "CompanyId": "c41e9e3f-b9a2-461b-8896-0f68dd494304",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 6",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 7"
          },
          "Section": {
            "FormTypeSectionId": "83540df9-202f-442f-82c3-c8e221eb11f4",
            "Name": "sample string 1",
            "Label": "sample string 2",
            "DisplayOrder": 1,
            "IsRepeatable": true,
            "VisibleExpression": "sample string 4",
            "SourceSystemId": "sample string 5"
          },
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "bcc70a70-465d-4846-a87e-45e26eb046bb",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "e94b81d1-4158-4adb-8bff-eb0da0c4044e",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "30e62fd8-92d4-4c02-af89-22c9d7613f57",
            "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "5aa20e3c-2191-4bb5-bd11-551b1b9d27a0",
              "FieldId": "ae9ba945-5d05-461a-adea-ceeb71bfa401",
              "FieldName": "sample string 1",
              "FieldLabel": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            }
          ],
          "ValueExpression": "sample string 5",
          "RequiredExpression": "sample string 6",
          "IsAttachment": true,
          "DefaultValueExpression": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "IsRepeatable": true,
          "VisibleExpression": "sample string 12",
          "SourceSystemId": "sample string 13"
        },
        "SectionIndex": 1,
        "FieldIndex": 1,
        "FileName": "sample string 1",
        "FileType": "sample string 2",
        "FileSize": 1,
        "FileContent": "QEA=",
        "ValueText": "sample string 3",
        "IsValid": true,
        "IsValidMessage": "sample string 5",
        "SourceSystemId": "sample string 6"
      }
    ],
    "SourceSystemId": "sample string 2",
    "CompanyId": "91f9dba5-0f7b-4188-9793-a285489654b5",
    "CreateDate": "2025-10-31T00:35:27.5429729-07:00",
    "CreateUser": "sample string 4",
    "LastModifiedDate": "2025-10-31T00:35:27.5429729-07:00",
    "LastModifiedUser": "sample string 5"
  },
  "Total": 1,
  "Message": "sample string 1"
}