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	Type	Additional information
Data	Form	None.
Total	integer	None.
Message	string	None.
Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "FormId": "afa33b99-1c20-464f-899b-6727819dc8cc",
    "Asset": {
      "AssetId": "60086f8d-0ebe-472e-b3a7-1da278f04251",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "603124fc-2470-4bd6-ad70-f0197cca649c",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
        "MeasurementValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "24b35939-3836-43e6-a08c-250ecf85fa7c",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "a2c28ad4-f2ae-43c0-9d04-af121d1a2252",
        "EffectiveDate": "2024-11-21T04:52:54.1638215-08:00",
        "StateType": {
          "StateTypeId": "dd39d3db-ccba-4bae-bc1a-b1b7dcd617ef",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "46315310-d638-4c3a-9556-3e92d742ed69",
          "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "580ec02d-1086-4cf0-ba63-da3a3e742d5f",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "0046c245-d9b0-4986-8347-30af8827f11c",
        "EffectiveDate": "2024-11-21T04:52:54.1638215-08:00",
        "StatusType": {
          "StatusTypeId": "e2d3389c-6cad-4f83-ba8e-9dbcf6783212",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "57945d06-a910-4381-91fb-cdba2e3d716e",
          "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "2c1314df-03ac-46a9-940d-951d232c2406",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "b1e0cff1-42e9-4d0c-935d-780ac07fa617",
        "EffectiveDate": "2024-11-21T04:52:54.1638215-08:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "fde078bb-60e0-4bd8-84f2-3f252e2f549c",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "ed7651b1-335f-4cab-b7ef-f2a7929d8901",
          "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "5dde626e-7813-4462-b62f-c90c4331194a",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
      "MeasurementValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "77a37b21-9c8f-4599-b87b-f16d4b5468d9",
      "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "FormType": {
      "FormTypeId": "3815d9ec-7e61-4051-a8b1-556fd2a131ef",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AssetType": {
        "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
        "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "FrequencyNeeded": 1,
      "ValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
      "Fields": [
        {
          "FormTypeFieldId": "dd7104a2-3f13-4196-990a-b9bbec9ae836",
          "Section": {
            "FormTypeSectionId": "3f6fe7dd-349f-4165-a7a8-971aabf797f6",
            "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": "230a03b8-3161-4d91-813f-e0042136fdbf",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "604c84e2-6160-4674-a777-e580ef59cebb",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "71b30c04-6f1a-4977-b02e-a7c2be08356c",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "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": "dd7104a2-3f13-4196-990a-b9bbec9ae836",
          "Section": {
            "FormTypeSectionId": "3f6fe7dd-349f-4165-a7a8-971aabf797f6",
            "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": "230a03b8-3161-4d91-813f-e0042136fdbf",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "604c84e2-6160-4674-a777-e580ef59cebb",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "71b30c04-6f1a-4977-b02e-a7c2be08356c",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "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 3",
      "CompanyId": "e0d09048-38df-4138-b726-8a6a3d64ac0b",
      "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "EffectiveDate": "2024-11-21T04:52:54.1638215-08:00",
    "Location": "sample string 1",
    "TaskId": "432ab09b-9995-4538-818c-22499134346c",
    "Values": [
      {
        "FormFieldValueId": "65608c17-26fc-436f-8a41-a485419e0509",
        "FormId": "7a42ba8b-3cfa-42fc-9f25-130122161590",
        "FormTypeField": {
          "FormTypeFieldId": "dd7104a2-3f13-4196-990a-b9bbec9ae836",
          "FormType": {
            "FormTypeId": "3815d9ec-7e61-4051-a8b1-556fd2a131ef",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "AssetType": {
              "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
              "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
              "LastModifiedUser": "sample string 8"
            },
            "FrequencyNeeded": 1,
            "ValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
            "Fields": [],
            "SourceSystemId": "sample string 3",
            "CompanyId": "e0d09048-38df-4138-b726-8a6a3d64ac0b",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "Section": {
            "FormTypeSectionId": "3f6fe7dd-349f-4165-a7a8-971aabf797f6",
            "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": "230a03b8-3161-4d91-813f-e0042136fdbf",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "604c84e2-6160-4674-a777-e580ef59cebb",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "71b30c04-6f1a-4977-b02e-a7c2be08356c",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "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": "65608c17-26fc-436f-8a41-a485419e0509",
        "FormId": "7a42ba8b-3cfa-42fc-9f25-130122161590",
        "FormTypeField": {
          "FormTypeFieldId": "dd7104a2-3f13-4196-990a-b9bbec9ae836",
          "FormType": {
            "FormTypeId": "3815d9ec-7e61-4051-a8b1-556fd2a131ef",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "AssetType": {
              "AssetTypeId": "a45c5769-fc3b-4165-bd8d-4192e4dde7b4",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "1db86687-17f6-4513-86bd-fd0dc02294b0",
              "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
              "LastModifiedUser": "sample string 8"
            },
            "FrequencyNeeded": 1,
            "ValueNeededDate": "2024-11-21T04:52:54.1638215-08:00",
            "Fields": [],
            "SourceSystemId": "sample string 3",
            "CompanyId": "e0d09048-38df-4138-b726-8a6a3d64ac0b",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "Section": {
            "FormTypeSectionId": "3f6fe7dd-349f-4165-a7a8-971aabf797f6",
            "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": "230a03b8-3161-4d91-813f-e0042136fdbf",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "604c84e2-6160-4674-a777-e580ef59cebb",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "71b30c04-6f1a-4977-b02e-a7c2be08356c",
            "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
            "LastModifiedUser": "sample string 6"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "sample string 2",
              "ValueText": "sample string 3",
              "LabelText": "sample string 4"
            },
            {
              "ValidValueId": "57acfe8c-578a-4d40-bacf-e4ec955d4a70",
              "FieldId": "08d3cd27-fa3e-4c59-8aa4-6ceb2f17592e",
              "FieldName": "sample string 1",
              "FieldLable": "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": "77d1f239-916b-4095-9ca1-116732741ffc",
    "CreateDate": "2024-11-21T04:52:54.1638215-08:00",
    "CreateUser": "sample string 4",
    "LastModifiedDate": "2024-11-21T04:52:54.1638215-08:00",
    "LastModifiedUser": "sample string 5"
  },
  "Total": 1,
  "Message": "sample string 1"
}